@caraer/client 2.0.504 → 2.0.506

package/docs/CMSV2TransferApi.md

@@ -0,0 +1,230 @@
+# CMSV2TransferApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**attach**](#attach) | **POST** /api/v2/company/{companyUuid}/cms-transfer/attach | Attach a manually created caraer-web project|
+|[**cutover**](#cutover) | **POST** /api/v2/company/{companyUuid}/cms-transfer/cutover | Switch the live site to CMS v2: schema, caraer-web repo, and hostname|
+|[**rollback**](#rollback) | **POST** /api/v2/company/{companyUuid}/cms-transfer/rollback | Restore the live hostname to the stored v1 project|
+|[**status**](#status) | **GET** /api/v2/company/{companyUuid}/cms-transfer | Transfer status for one company|
+
+# **attach**
+> ShowResponseCompanyDTO attach(requestBody)
+
+
+### Example
+
+```typescript
+import {
+    CMSV2TransferApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2TransferApi(configuration);
+
+let companyUuid: string; // (default to undefined)
+let requestBody: { [key: string]: string; }; //
+
+const { status, data } = await apiInstance.attach(
+    companyUuid,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **{ [key: string]: string; }**|  | |
+| **companyUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseCompanyDTO**
+
+### 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)
+
+# **cutover**
+> ShowResponseCompanyDTO cutover()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2TransferApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2TransferApi(configuration);
+
+let companyUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cutover(
+    companyUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseCompanyDTO**
+
+### 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)
+
+# **rollback**
+> ShowResponseCompanyDTO rollback()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2TransferApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2TransferApi(configuration);
+
+let companyUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.rollback(
+    companyUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponseCompanyDTO**
+
+### 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)
+
+# **status**
+> ShowResponseMapStringObject status()
+
+
+### Example
+
+```typescript
+import {
+    CMSV2TransferApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new CMSV2TransferApi(configuration);
+
+let companyUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.status(
+    companyUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **companyUuid** | [**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)
+

package/docs/CalendarsApi.md

@@ -5,8 +5,8 @@ All URIs are relative to *https://v2.api.caraer.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**bootstrap**](#bootstrap) | **POST** /api/v2/calendars/bootstrap | Ensure calendar schema, default calendar, and event backfill|
-|[**create3**](#create3) | **POST** /api/v2/calendars | Create a calendar owned by the current user|
-|[**list1**](#list1) | **GET** /api/v2/calendars | List calendars visible to the current company|
+|[**create4**](#create4) | **POST** /api/v2/calendars | Create a calendar owned by the current user|
+|[**list3**](#list3) | **GET** /api/v2/calendars | List calendars visible to the current company|
 |[**listTeams**](#listteams) | **GET** /api/v2/calendars/teams | List teams that can be linked to a calendar|
 
 # **bootstrap**
@@ -57,8 +57,8 @@ This endpoint does not have any parameters.
 
 [[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)
 
-# **create3**
-> CreateResponseCalendarRecordDTO create3(calendarCreateRequest)
+# **create4**
+> CreateResponseCalendarRecordDTO create4(calendarCreateRequest)
 
 
 ### Example
@@ -75,7 +75,7 @@ const apiInstance = new CalendarsApi(configuration);
 
 let calendarCreateRequest: CalendarCreateRequest; //
 
-const { status, data } = await apiInstance.create3(
+const { status, data } = await apiInstance.create4(
     calendarCreateRequest
 );
 ```
@@ -113,8 +113,8 @@ const { status, data } = await apiInstance.create3(
 
 [[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)
 
-# **list1**
-> SuccessResponseListCalendarRecordDTO list1()
+# **list3**
+> SuccessResponseListCalendarRecordDTO list3()
 
 
 ### Example
@@ -128,7 +128,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new CalendarsApi(configuration);
 
-const { status, data } = await apiInstance.list1();
+const { status, data } = await apiInstance.list3();
 ```
 
 ### Parameters

package/docs/CmsEnvironmentDTO.md

@@ -0,0 +1,36 @@
+# CmsEnvironmentDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**key** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**routing** | **string** |  | [optional] [default to undefined]
+**slugPrefix** | **string** |  | [optional] [default to undefined]
+**hostLabel** | **string** |  | [optional] [default to undefined]
+**requiresAuth** | **boolean** |  | [optional] [default to undefined]
+**htmlLang** | **string** |  | [optional] [default to undefined]
+**_default** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsEnvironmentDTO } from '@caraer/client';
+
+const instance: CmsEnvironmentDTO = {
+    uuid,
+    key,
+    label,
+    routing,
+    slugPrefix,
+    hostLabel,
+    requiresAuth,
+    htmlLang,
+    _default,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsModuleDTO.md

@@ -0,0 +1,52 @@
+# CmsModuleDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**ref** | **string** |  | [optional] [default to undefined]
+**kind** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**category** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**preview** | **string** |  | [optional] [default to undefined]
+**appUuid** | **string** |  | [optional] [default to undefined]
+**appName** | **string** |  | [optional] [default to undefined]
+**appLabel** | **string** |  | [optional] [default to undefined]
+**packageName** | **string** |  | [optional] [default to undefined]
+**version** | **string** |  | [optional] [default to undefined]
+**retired** | **boolean** |  | [optional] [default to undefined]
+**fields** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) |  | [optional] [default to undefined]
+**frameworks** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsModuleDTO } from '@caraer/client';
+
+const instance: CmsModuleDTO = {
+    uuid,
+    name,
+    label,
+    ref,
+    kind,
+    description,
+    category,
+    icon,
+    preview,
+    appUuid,
+    appName,
+    appLabel,
+    packageName,
+    version,
+    retired,
+    fields,
+    frameworks,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPageDTO.md

@@ -0,0 +1,44 @@
+# CmsPageDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**locale** | **string** |  | [optional] [default to undefined]
+**environment** | **string** |  | [optional] [default to undefined]
+**state** | **string** |  | [optional] [default to undefined]
+**published** | **boolean** |  | [optional] [default to undefined]
+**document** | [**CmsPageDocument**](CmsPageDocument.md) |  | [optional] [default to undefined]
+**record** | [**RecordSummary**](RecordSummary.md) |  | [optional] [default to undefined]
+**protection** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**locales** | **Array<string>** |  | [optional] [default to undefined]
+**publishAt** | **number** |  | [optional] [default to undefined]
+**unpublishAt** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPageDTO } from '@caraer/client';
+
+const instance: CmsPageDTO = {
+    uuid,
+    title,
+    slug,
+    locale,
+    environment,
+    state,
+    published,
+    document,
+    record,
+    protection,
+    locales,
+    publishAt,
+    unpublishAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPageDocument.md

@@ -0,0 +1,38 @@
+# CmsPageDocument
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **number** |  | [optional] [default to undefined]
+**revision** | **number** |  | [optional] [default to undefined]
+**modules** | [**Array<CmsPageModuleInstance>**](CmsPageModuleInstance.md) |  | [optional] [default to undefined]
+**seo** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**excerpt** | **string** |  | [optional] [default to undefined]
+**css** | **string** |  | [optional] [default to undefined]
+**headJs** | **string** |  | [optional] [default to undefined]
+**bodyJs** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPageDocument } from '@caraer/client';
+
+const instance: CmsPageDocument = {
+    version,
+    revision,
+    modules,
+    seo,
+    title,
+    slug,
+    excerpt,
+    css,
+    headJs,
+    bodyJs,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPageModuleInstance.md

@@ -0,0 +1,26 @@
+# CmsPageModuleInstance
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**module** | **string** |  | [optional] [default to undefined]
+**fields** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**hidden** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPageModuleInstance } from '@caraer/client';
+
+const instance: CmsPageModuleInstance = {
+    id,
+    module,
+    fields,
+    hidden,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPagePatch.md

@@ -0,0 +1,40 @@
+# CmsPagePatch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**op** | **string** |  | [optional] [default to undefined]
+**moduleId** | **string** |  | [optional] [default to undefined]
+**field** | **string** |  | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
+**fields** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**module** | [**CmsPageModuleInstance**](CmsPageModuleInstance.md) |  | [optional] [default to undefined]
+**index** | **number** |  | [optional] [default to undefined]
+**toIndex** | **number** |  | [optional] [default to undefined]
+**hidden** | **boolean** |  | [optional] [default to undefined]
+**modules** | [**Array<CmsPageModuleInstance>**](CmsPageModuleInstance.md) |  | [optional] [default to undefined]
+**seo** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPagePatch } from '@caraer/client';
+
+const instance: CmsPagePatch = {
+    op,
+    moduleId,
+    field,
+    value,
+    fields,
+    module,
+    index,
+    toIndex,
+    hidden,
+    modules,
+    seo,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPagePatchRequest.md

@@ -0,0 +1,24 @@
+# CmsPagePatchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locale** | **string** |  | [optional] [default to undefined]
+**patches** | [**Array<CmsPagePatch>**](CmsPagePatch.md) |  | [optional] [default to undefined]
+**expectedRevision** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPagePatchRequest } from '@caraer/client';
+
+const instance: CmsPagePatchRequest = {
+    locale,
+    patches,
+    expectedRevision,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CmsPublicMenuDTO.md

@@ -0,0 +1,24 @@
+# CmsPublicMenuDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**items** | [**Array<WebMenuItem>**](WebMenuItem.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CmsPublicMenuDTO } from '@caraer/client';
+
+const instance: CmsPublicMenuDTO = {
+    location,
+    title,
+    items,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CompanyDTO.md

@@ -20,6 +20,10 @@ Name | Type | Description | Notes
 **digitalIdentity** | [**DigitalIdentityDTO**](DigitalIdentityDTO.md) | The digital identity of the company. | [optional] [default to undefined]
 **websiteSettings** | [**WebsiteSettingsDTO**](WebsiteSettingsDTO.md) | The website settings of the company. | [optional] [default to undefined]
 **billingSettings** | [**BillingSettingsDTO**](BillingSettingsDTO.md) | The billing settings of the company. | [optional] [default to undefined]
+**cmsVersion** | **number** | Which CMS serves this company: 1 = WerkenBij, 2 = caraer-web | [optional] [default to undefined]
+**cmsV2PreviewOrigin** | **string** | Origin of the v2 sidecar site while the live hostname is still v1 | [optional] [default to undefined]
+**cmsV2ProjectId** | **string** |  | [optional] [default to undefined]
+**cmsV1ProjectId** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -41,6 +45,10 @@ const instance: CompanyDTO = {
     digitalIdentity,
     websiteSettings,
     billingSettings,
+    cmsVersion,
+    cmsV2PreviewOrigin,
+    cmsV2ProjectId,
+    cmsV1ProjectId,
 };
 ```
 

package/docs/DeveloperSandboxesApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://v2.api.caraer.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**create1**](#create1) | **POST** /api/v2/developer-sandboxes | Create a developer sandbox|
-|[**list**](#list) | **GET** /api/v2/developer-sandboxes | List developer sandboxes|
+|[**list1**](#list1) | **GET** /api/v2/developer-sandboxes | List developer sandboxes|
 |[**show2**](#show2) | **GET** /api/v2/developer-sandboxes/{uuid} | Get a developer sandbox|
 
 # **create1**
@@ -65,8 +65,8 @@ const { status, data } = await apiInstance.create1(
 
 [[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)
 
-# **list**
-> SuccessResponseListDeveloperSandboxDTO list()
+# **list1**
+> SuccessResponseListDeveloperSandboxDTO list1()
 
 Lists sandboxes owned by the caller\'s selected company.
 
@@ -81,7 +81,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DeveloperSandboxesApi(configuration);
 
-const { status, data } = await apiInstance.list();
+const { status, data } = await apiInstance.list1();
 ```
 
 ### Parameters