@product-live/api-sdk 2.5.1 → 2.8.1

package/VariableApi.md

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