@caraer/client 2.0.504 → 2.0.506

package/docs/AppSettingFieldSchema.md

@@ -15,8 +15,13 @@ Name | Type | Description | Notes
 **actionSource** | [**AppSettingActionSource**](AppSettingActionSource.md) |  | [optional] [default to undefined]
 **defaultValue** | **any** |  | [optional] [default to undefined]
 **hidden** | **boolean** |  | [optional] [default to undefined]
+**advanced** | **boolean** |  | [optional] [default to undefined]
 **filterTraits** | **Array<string>** |  | [optional] [default to undefined]
 **visibleWhen** | [**Array<AppSettingCondition>**](AppSettingCondition.md) |  | [optional] [default to undefined]
+**itemFields** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) |  | [optional] [default to undefined]
+**min** | **number** |  | [optional] [default to undefined]
+**max** | **number** |  | [optional] [default to undefined]
+**itemLabel** | **string** |  | [optional] [default to undefined]
 **value** | **any** |  | [optional] [default to undefined]
 **hasValue** | **boolean** |  | [optional] [default to undefined]
 **mappingValue** | [**AppSettingFieldMappingStructure**](AppSettingFieldMappingStructure.md) |  | [optional] [default to undefined]
@@ -39,8 +44,13 @@ const instance: AppSettingFieldSchema = {
     actionSource,
     defaultValue,
     hidden,
+    advanced,
     filterTraits,
     visibleWhen,
+    itemFields,
+    min,
+    max,
+    itemLabel,
     value,
     hasValue,
     mappingValue,

package/docs/CMSModulesApi.md

@@ -0,0 +1,181 @@
+# CMSModulesApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**list**](#list) | **GET** /api/v2/apps/{appUuid}/cms-modules | List an app\'s CMS modules|
+|[**publishPackage**](#publishpackage) | **POST** /api/v2/apps/{appUuid}/cms-modules/package | Publish an app\'s CMS module package|
+|[**upsert**](#upsert) | **PUT** /api/v2/apps/{appUuid}/cms-modules | Replace an app\'s CMS module catalog|
+
+# **list**
+> ShowResponseListCmsModuleDTO list()
+
+Includes retired modules, so a developer can see what a push removed.
+
+### Example
+
+```typescript
+import {
+    CMSModulesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSModulesApi(configuration);
+
+let appUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.list(
+    appUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseListCmsModuleDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **publishPackage**
+> ShowResponseListCmsModuleDTO publishPackage(requestBody)
+
+Accepts a staged npm tarball (base64) and module manifests. Publishes to the platform registry with the host token, then replaces the catalog.
+
+### Example
+
+```typescript
+import {
+    CMSModulesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSModulesApi(configuration);
+
+let appUuid: string; // (default to undefined)
+let requestBody: { [key: string]: any | null; }; //
+
+const { status, data } = await apiInstance.publishPackage(
+    appUuid,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **{ [key: string]: any | null; }**|  | |
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseListCmsModuleDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **upsert**
+> ShowResponseListCmsModuleDTO upsert(requestBody)
+
+Registers the modules shipped by a published package version. Modules missing from the payload are retired rather than deleted, because pages may still reference them.
+
+### Example
+
+```typescript
+import {
+    CMSModulesApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSModulesApi(configuration);
+
+let appUuid: string; // (default to undefined)
+let requestBody: { [key: string]: any | null; }; //
+
+const { status, data } = await apiInstance.upsert(
+    appUuid,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **{ [key: string]: any | null; }**|  | |
+| **appUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseListCmsModuleDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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/docs/CMSV2EnvironmentsApi.md

@@ -0,0 +1,396 @@
+# CMSV2EnvironmentsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**create3**](#create3) | **POST** /api/v2/cms/environments | Create an environment|
+|[**delete1**](#delete1) | **DELETE** /api/v2/cms/environments/{key} | Delete an environment except main|
+|[**group**](#group) | **GET** /api/v2/cms/environments/translations/{recordUuid} | Translation group for a record|
+|[**link**](#link) | **POST** /api/v2/cms/environments/translations/{fromUuid}/link/{toUuid} | Link two records as translations|
+|[**list2**](#list2) | **GET** /api/v2/cms/environments | List company environments|
+|[**unlink**](#unlink) | **DELETE** /api/v2/cms/environments/translations/{fromUuid}/link/{toUuid} | Unlink a translation edge|
+|[**update1**](#update1) | **PUT** /api/v2/cms/environments/{key} | Update routing, auth or htmlLang. Keys are immutable.|
+
+# **create3**
+> ShowResponseCmsEnvironmentDTO create3(cmsEnvironmentDTO)
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration,
+    CmsEnvironmentDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let cmsEnvironmentDTO: CmsEnvironmentDTO; //
+
+const { status, data } = await apiInstance.create3(
+    cmsEnvironmentDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cmsEnvironmentDTO** | **CmsEnvironmentDTO**|  | |
+
+
+### Return type
+
+**ShowResponseCmsEnvironmentDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **delete1**
+> SuccessResponseString delete1()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let key: string; // (default to undefined)
+
+const { status, data } = await apiInstance.delete1(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **group**
+> ShowResponseMapStringObject group()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let recordUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.group(
+    recordUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **recordUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseMapStringObject**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **link**
+> SuccessResponseString link()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let fromUuid: string; // (default to undefined)
+let toUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.link(
+    fromUuid,
+    toUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fromUuid** | [**string**] |  | defaults to undefined|
+| **toUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **list2**
+> ShowResponseListCmsEnvironmentDTO list2()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+const { status, data } = await apiInstance.list2();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**ShowResponseListCmsEnvironmentDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **unlink**
+> SuccessResponseString unlink()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let fromUuid: string; // (default to undefined)
+let toUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.unlink(
+    fromUuid,
+    toUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **fromUuid** | [**string**] |  | defaults to undefined|
+| **toUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponseString**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+
+# **update1**
+> ShowResponseCmsEnvironmentDTO update1(cmsEnvironmentDTO)
+
+
+### Example
+
+```typescript
+import {
+    CMSV2EnvironmentsApi,
+    Configuration,
+    CmsEnvironmentDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2EnvironmentsApi(configuration);
+
+let key: string; // (default to undefined)
+let cmsEnvironmentDTO: CmsEnvironmentDTO; //
+
+const { status, data } = await apiInstance.update1(
+    key,
+    cmsEnvironmentDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cmsEnvironmentDTO** | **CmsEnvironmentDTO**|  | |
+| **key** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseCmsEnvironmentDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**401** | Authentication is required or the token is invalid. |  -  |
+|**403** | The caller is missing a required role or scope. |  -  |
+|**404** | The requested resource was not found. |  -  |
+|**500** | An internal server error occurred. |  -  |
+
+[[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)
+