1.0.0-beta.197

flyocloud · Aug 23, 2024 · debb1aa · debb1aa
1 parent fcd6980
commit debb1aa
Show file tree

Hide file tree

Showing 42 changed files with 1,204 additions and 63 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -11,6 +11,14 @@ docs/Entity.md
 docs/EntityInterface.md
 docs/EntityMetric.md
 docs/EntityinterfaceInner.md
+docs/FieldAddress.md
+docs/FieldCheckboxList.md
+docs/FieldDropdown.md
+docs/FieldFile.md
+docs/FieldImage.md
+docs/FieldLink.md
+docs/FieldSchema.md
+docs/FieldWysiwyg.md
 docs/Meta.md
 docs/Page.md
 docs/PageBreadcrumbInner.md
@@ -38,6 +46,14 @@ src/model/Entity.js
 src/model/EntityInterface.js
 src/model/EntityMetric.js
 src/model/EntityinterfaceInner.js
+src/model/FieldAddress.js
+src/model/FieldCheckboxList.js
+src/model/FieldDropdown.js
+src/model/FieldFile.js
+src/model/FieldImage.js
+src/model/FieldLink.js
+src/model/FieldSchema.js
+src/model/FieldWysiwyg.js
 src/model/Meta.js
 src/model/Page.js
 src/model/PageBreadcrumbInner.js

diff --git a/docs/EntitiesApi.md b/docs/EntitiesApi.md
@@ -31,8 +31,8 @@ ApiToken.apiKey = 'YOUR API KEY';
 let apiInstance = new FlyoNitroJs.EntitiesApi();
 let slug = "hello-world"; // String | When looking up an entity slug, it is advisable to provide the typeId parameter along with it, as slugs are not unique among other entities. Failing to include the typeId parameter may lead to unintended or incorrect results. By specifying the typeId, you can ensure more accurate and targeted retrieval of the desired entity.
 let opts = {
-  'lang': "de", // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
-  'typeId': 123 // Number | To ensure accurate lookup, it is considered a best practice to include the Type-ID of the entity associated with the slug. The Type-ID, alternatively referred to as the Entity-Definition-Schema ID, serves as a crucial identifier within the system. It uniquely distinguishes and categorizes the Entity-Definition-Schema.
+  'typeId': 123, // Number | To ensure accurate lookup, it is considered a best practice to include the Type-ID of the entity associated with the slug. The Type-ID, alternatively referred to as the Entity-Definition-Schema ID, serves as a crucial identifier within the system. It uniquely distinguishes and categorizes the Entity-Definition-Schema.
+  'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
 };
 apiInstance.entityBySlug(slug, opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -48,8 +48,8 @@ apiInstance.entityBySlug(slug, opts).then((data) => {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **slug** | **String**| When looking up an entity slug, it is advisable to provide the typeId parameter along with it, as slugs are not unique among other entities. Failing to include the typeId parameter may lead to unintended or incorrect results. By specifying the typeId, you can ensure more accurate and targeted retrieval of the desired entity. | 
- **lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won&#39;t have any effect | [optional] 
  **typeId** | **Number**| To ensure accurate lookup, it is considered a best practice to include the Type-ID of the entity associated with the slug. The Type-ID, alternatively referred to as the Entity-Definition-Schema ID, serves as a crucial identifier within the system. It uniquely distinguishes and categorizes the Entity-Definition-Schema. | [optional] 
+ **lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won&#39;t have any effect | [optional] 
 
 ### Return type
 

diff --git a/docs/FieldAddress.md b/docs/FieldAddress.md
@@ -0,0 +1,16 @@
+# FlyoNitroJs.FieldAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**zip** | **Number** |  | [optional] 
+**city** | **String** |  | [optional] 
+**streetName** | **String** |  | [optional] 
+**streetNr** | **String** |  | [optional] 
+**street** | **String** |  | [optional] 
+**address** | **String** |  | [optional] 
+**cordsLat** | **Number** |  | [optional] 
+**cordsLng** | **Number** |  | [optional] 
+
+
diff --git a/docs/FieldCheckboxList.md b/docs/FieldCheckboxList.md
@@ -0,0 +1,11 @@
+# FlyoNitroJs.FieldCheckboxList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**values** | **[String]** |  | [optional] 
+**options** | **Object** | All Options which are available in the checkbox and the user can select from | [optional] 
+**labels** | **[String]** |  | [optional] 
+
+
diff --git a/docs/FieldDropdown.md b/docs/FieldDropdown.md
@@ -0,0 +1,11 @@
+# FlyoNitroJs.FieldDropdown
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The option value which has been selected in flyo. | [optional] 
+**options** | **Object** | All Options which are available in the dropdown and the user can select from | [optional] 
+**label** | **String** | The option label which has been selected in flyo. | [optional] 
+
+
diff --git a/docs/FieldFile.md b/docs/FieldFile.md
@@ -0,0 +1,13 @@
+# FlyoNitroJs.FieldFile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **String** | Manipulatable image path, see https://dev.flyo.cloud/infos/images.html. | [optional] 
+**caption** | **String** | Describes the file or image | [optional] 
+**copyright** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**id** | **Number** | The unique identifier of the file or image as incremental number. | [optional] 
+
+
diff --git a/docs/FieldImage.md b/docs/FieldImage.md
@@ -0,0 +1,13 @@
+# FlyoNitroJs.FieldImage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **String** | Manipulatable image path, see https://dev.flyo.cloud/infos/images.html. | [optional] 
+**caption** | **String** | Describes the file or image | [optional] 
+**copyright** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**id** | **Number** | The unique identifier of the file or image as incremental number. | [optional] 
+
+
diff --git a/docs/FieldLink.md b/docs/FieldLink.md
@@ -0,0 +1,13 @@
+# FlyoNitroJs.FieldLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the link. Possible values are: nitropagelink, url, email, tel, file | [optional] 
+**target** | **String** | The target attribute of the link. Possible values are: _blank, _self | [optional] 
+**raw** | **String** | The not modified raw input value of flyo. | [optional] 
+**href** | **String** | The link in a href format. Which means links have a trailing slash. E-Mail links start with mailto: and phone links start with tel: | [optional] 
+**extras** | **Object** | Additional information about the link. This information can vary depending on the type of link. | [optional] 
+
+
diff --git a/docs/FieldSchema.md b/docs/FieldSchema.md
@@ -0,0 +1,10 @@
+# FlyoNitroJs.FieldSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Number** |  | [optional] 
+**uniqueId** | **String** |  | [optional] 
+
+
diff --git a/docs/FieldWysiwyg.md b/docs/FieldWysiwyg.md
@@ -0,0 +1,10 @@
+# FlyoNitroJs.FieldWysiwyg
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**html** | **String** |  | [optional] 
+**json** | **Object** | The TipTap json annotation can be parsed to html with a library f.e. https://github.com/ueberdosis/tiptap-php | [optional] 
+
+
diff --git a/docs/PagesApi.md b/docs/PagesApi.md
@@ -82,8 +82,8 @@ ApiToken.apiKey = 'YOUR API KEY';
 
 let apiInstance = new FlyoNitroJs.PagesApi();
 let opts = {
-  'lang': "de", // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
-  'slug': "foo/bar" // String | The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \"testpage/subpage\". In this way, a forward slash (\"/\") within the path is recognized as a valid character and processed accordingly.
+  'slug': "foo/bar", // String | The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \"testpage/subpage\". In this way, a forward slash (\"/\") within the path is recognized as a valid character and processed accordingly.
+  'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
 };
 apiInstance.page(opts).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -98,8 +98,8 @@ apiInstance.page(opts).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won&#39;t have any effect | [optional] 
  **slug** | **String**| The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \&quot;testpage/subpage\&quot;. In this way, a forward slash (\&quot;/\&quot;) within the path is recognized as a valid character and processed accordingly. | [optional] 
+ **lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won&#39;t have any effect | [optional] 
 
 ### Return type
 

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -2,7 +2,7 @@
  * Flyo Nitro
  * This document provides a comprehensive overview of all the endpoints available for Flyo Nitro, a powerful platform designed to facilitate the development of websites. Flyo Nitro is built upon three strategic pillars that play a central role in website development:  + Config: The config component is responsible for loading all the necessary elements required for seamless navigation within the website layout. This includes crucial elements like the navigation menu or global content, such as the \"Locations\" section of an entity, which can be utilized in the footer across all pages. + Pages: Pages are evaluated based on their unique slug (path) and encompass all the content needed to populate a specific page. This includes various content elements, known as blocks, as well as meta information like \"og-descriptions.\" Additionally, pages can dynamically incorporate content from entities by employing mapping techniques. + Entity: Entities can be retrieved by utilizing a unique identifier, which can be configured within Flyo Nitro. Each entity provides comprehensive details in the form of fields, offering specific content tailored to a particular context.  Furthermore, it is important to distinguish between the **development** and **production** environments in Flyo Nitro. In the development environment, any changes made to data within the Flyo User Interface are immediately accessible, even without saving. This feature enables users to have a live preview of the changes during data entry. On the other hand, the production environment exclusively utilizes saved data, ensuring that only finalized content is displayed.  For more detailed documentation in German, please visit: dev.flyo.cloud
  *
- * The version of the OpenAPI document: 1.0.0-beta.182
+ * The version of the OpenAPI document: 1.0.0-beta.197
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,7 +17,7 @@ import querystring from "querystring";
 
 /**
 * @module ApiClient
-* @version 1.0.0-beta.182
+* @version 1.0.0-beta.197
 */
 
 /**
@@ -55,7 +55,7 @@ class ApiClient {
          * @default {}
          */
         this.defaultHeaders = {
-            'User-Agent': 'OpenAPI-Generator/1.0.0-beta.182/Javascript'
+            'User-Agent': 'OpenAPI-Generator/1.0.0-beta.197/Javascript'
         };
 
         /**

diff --git a/src/api/ConfigApi.js b/src/api/ConfigApi.js
@@ -2,7 +2,7 @@
  * Flyo Nitro
  * This document provides a comprehensive overview of all the endpoints available for Flyo Nitro, a powerful platform designed to facilitate the development of websites. Flyo Nitro is built upon three strategic pillars that play a central role in website development:  + Config: The config component is responsible for loading all the necessary elements required for seamless navigation within the website layout. This includes crucial elements like the navigation menu or global content, such as the \"Locations\" section of an entity, which can be utilized in the footer across all pages. + Pages: Pages are evaluated based on their unique slug (path) and encompass all the content needed to populate a specific page. This includes various content elements, known as blocks, as well as meta information like \"og-descriptions.\" Additionally, pages can dynamically incorporate content from entities by employing mapping techniques. + Entity: Entities can be retrieved by utilizing a unique identifier, which can be configured within Flyo Nitro. Each entity provides comprehensive details in the form of fields, offering specific content tailored to a particular context.  Furthermore, it is important to distinguish between the **development** and **production** environments in Flyo Nitro. In the development environment, any changes made to data within the Flyo User Interface are immediately accessible, even without saving. This feature enables users to have a live preview of the changes during data entry. On the other hand, the production environment exclusively utilizes saved data, ensuring that only finalized content is displayed.  For more detailed documentation in German, please visit: dev.flyo.cloud
  *
- * The version of the OpenAPI document: 1.0.0-beta.182
+ * The version of the OpenAPI document: 1.0.0-beta.197
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,7 +18,7 @@ import ConfigResponse from '../model/ConfigResponse';
 /**
 * Config service.
 * @module api/ConfigApi
-* @version 1.0.0-beta.182
+* @version 1.0.0-beta.197
 */
 export default class ConfigApi {