@product-live/api-sdk 2.13.0 → 2.20.0

package/.openapi-generator/FILES

@@ -0,0 +1,74 @@
+.gitignore
+.openapi-generator-ignore
+DataFactoryFileApi.md
+DefaultApi.md
+ItemApi.md
+JobApi.md
+JobExecutionApi.md
+README.md
+TaskApi.md
+TaskExecutionApi.md
+VariableApi.md
+apis/DataFactoryFileApi.ts
+apis/DefaultApi.ts
+apis/ItemApi.ts
+apis/JobApi.ts
+apis/JobExecutionApi.ts
+apis/TaskApi.ts
+apis/TaskExecutionApi.ts
+apis/VariableApi.ts
+apis/baseapi.ts
+apis/exception.ts
+auth/auth.ts
+configuration.ts
+git_push.sh
+http/http.ts
+http/isomorphic-fetch.ts
+index.ts
+middleware.ts
+models/CreateJobDto.ts
+models/CreateJobExecutionDto.ts
+models/CreateTaskDto.ts
+models/CreateVariableDto.ts
+models/FileDto.ts
+models/FindVariablesRequest.ts
+models/GetFiles200Response.ts
+models/GetItems200Response.ts
+models/GetJobExecutionById400Response.ts
+models/GetJobExecutions200Response.ts
+models/GetJobs200Response.ts
+models/GetTasks200Response.ts
+models/GetVariables200Response.ts
+models/HighOrderQuery.ts
+models/ItemDto.ts
+models/ItemFieldDTO.ts
+models/ItemFieldFile.ts
+models/ItemFieldFileData.ts
+models/ItemFieldMultipleSelectWithCommentAndQuantity.ts
+models/ItemFieldMultipleSelectWithCommentAndQuantityData.ts
+models/ItemFieldSimpleNumber.ts
+models/ItemFieldSimpleString.ts
+models/ItemFieldSimpleStringArray.ts
+models/ItemMetadataDTO.ts
+models/JobDto.ts
+models/JobExecutionDto.ts
+models/LowOrderQuery.ts
+models/LowOrderQueryValue.ts
+models/ObjectSerializer.ts
+models/PatchTaskExecutionDto.ts
+models/Query1.ts
+models/TaskDto.ts
+models/TaskExecutionDto.ts
+models/UpdateJobDto.ts
+models/UpdateTaskDto.ts
+models/UpdateVariableDto.ts
+models/VariableDto.ts
+models/all.ts
+package.json
+rxjsStub.ts
+servers.ts
+tsconfig.json
+types/ObjectParamAPI.ts
+types/ObservableAPI.ts
+types/PromiseAPI.ts
+util.ts

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.6.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/ItemApi.md

@@ -0,0 +1,125 @@
+# .ItemApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getItemById**](ItemApi.md#getItemById) | **GET** /v1/items/{id} | (Experimental) - Get a Item by id
+[**getItems**](ItemApi.md#getItems) | **GET** /v1/items | (Experimental) - Get a list of Item
+
+
+# **getItemById**
+> ItemDto getItemById()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .ItemApi(configuration);
+
+let body:.ItemApiGetItemByIdRequest = {
+  // string
+  id: "id_example",
+};
+
+apiInstance.getItemById(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
+
+**ItemDto**
+
+### 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** | Item 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)
+
+# **getItems**
+> GetItems200Response getItems()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .ItemApi(configuration);
+
+let body:.ItemApiGetItemsRequest = {
+  // number (optional)
+  size: 10,
+  // number (optional)
+  page: 0,
+};
+
+apiInstance.getItems(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
+
+**GetItems200Response**
+
+### 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 Item |  -  |
+**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/ItemApi.ts

@@ -0,0 +1,197 @@
+// 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 { GetItems200Response } from '../models/GetItems200Response';
+import { GetJobExecutionById400Response } from '../models/GetJobExecutionById400Response';
+import { ItemDto } from '../models/ItemDto';
+
+/**
+ * no description
+ */
+export class ItemApiRequestFactory extends BaseAPIRequestFactory {
+
+    /**
+     * (Experimental) - Get a Item by id
+     * @param id 
+     */
+    public async getItemById(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("ItemApi", "getItemById", "id");
+        }
+
+
+        // Path Params
+        const localVarPath = '/v1/items/{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 Item
+     * @param size 
+     * @param page 
+     */
+    public async getItems(size?: number, page?: number, _options?: Configuration): Promise<RequestContext> {
+        let _config = _options || this.configuration;
+
+
+
+        // Path Params
+        const localVarPath = '/v1/items';
+
+        // 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;
+    }
+
+}
+
+export class ItemApiResponseProcessor {
+
+    /**
+     * 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 getItemById
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+     public async getItemById(response: ResponseContext): Promise<ItemDto > {
+        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+        if (isCodeInRange("200", response.httpStatusCode)) {
+            const body: ItemDto = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "ItemDto", ""
+            ) as ItemDto;
+            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: ItemDto = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "ItemDto", ""
+            ) as ItemDto;
+            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 getItems
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+     public async getItems(response: ResponseContext): Promise<GetItems200Response > {
+        const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+        if (isCodeInRange("200", response.httpStatusCode)) {
+            const body: GetItems200Response = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "GetItems200Response", ""
+            ) as GetItems200Response;
+            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: GetItems200Response = ObjectSerializer.deserialize(
+                ObjectSerializer.parse(await response.body.text(), contentType),
+                "GetItems200Response", ""
+            ) as GetItems200Response;
+            return body;
+        }
+
+        throw new ApiException<string | Buffer | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers);
+    }
+
+}

package/dist/apis/DataFactoryFileApi.d.ts

@@ -1,15 +1,15 @@
-import { BaseAPIRequestFactory } from './baseapi';
-import { Configuration } from '../configuration';
-import { RequestContext, ResponseContext, HttpFile } from '../http/http';
-import { FileDto } from '../models/FileDto';
-import { GetFiles200Response } from '../models/GetFiles200Response';
-export declare class DataFactoryFileApiRequestFactory extends BaseAPIRequestFactory {
-    getFileById(id: string, _options?: Configuration): Promise<RequestContext>;
-    getFiles(size?: number, page?: number, _options?: Configuration): Promise<RequestContext>;
-    uploadFile(file: HttpFile, _options?: Configuration): Promise<RequestContext>;
-}
-export declare class DataFactoryFileApiResponseProcessor {
-    getFileById(response: ResponseContext): Promise<FileDto>;
-    getFiles(response: ResponseContext): Promise<GetFiles200Response>;
-    uploadFile(response: ResponseContext): Promise<FileDto>;
-}
+import { BaseAPIRequestFactory } from './baseapi';
+import { Configuration } from '../configuration';
+import { RequestContext, ResponseContext, HttpFile } from '../http/http';
+import { FileDto } from '../models/FileDto';
+import { GetFiles200Response } from '../models/GetFiles200Response';
+export declare class DataFactoryFileApiRequestFactory extends BaseAPIRequestFactory {
+    getFileById(id: string, _options?: Configuration): Promise<RequestContext>;
+    getFiles(size?: number, page?: number, _options?: Configuration): Promise<RequestContext>;
+    uploadFile(file: HttpFile, _options?: Configuration): Promise<RequestContext>;
+}
+export declare class DataFactoryFileApiResponseProcessor {
+    getFileById(response: ResponseContext): Promise<FileDto>;
+    getFiles(response: ResponseContext): Promise<GetFiles200Response>;
+    uploadFile(response: ResponseContext): Promise<FileDto>;
+}