@roomle/embedding-lib 4.24.0-alpha.1 → 4.24.0-alpha.5

package/docs/api/enums/types.UI_BUTTON.md

@@ -0,0 +1,175 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UI\_BUTTON
+
+# Enumeration: UI\_BUTTON
+
+[types](../modules/types.md).UI_BUTTON
+
+## Table of contents
+
+### Enumeration members
+
+- [ADDONS](types.UI_BUTTON.md#addons)
+- [AR](types.UI_BUTTON.md#ar)
+- [DIMENSIONS](types.UI_BUTTON.md#dimensions)
+- [EXPORT\_3D](types.UI_BUTTON.md#export_3d)
+- [FULLSCREEN](types.UI_BUTTON.md#fullscreen)
+- [MULTISELECT](types.UI_BUTTON.md#multiselect)
+- [PARTLIST](types.UI_BUTTON.md#partlist)
+- [PAUSECONFIGURE](types.UI_BUTTON.md#pauseconfigure)
+- [RENDERIMAGE](types.UI_BUTTON.md#renderimage)
+- [REQUESTPLAN](types.UI_BUTTON.md#requestplan)
+- [REQUESTPRODUCT](types.UI_BUTTON.md#requestproduct)
+- [RESETCAMERA](types.UI_BUTTON.md#resetcamera)
+- [ROTATE](types.UI_BUTTON.md#rotate)
+- [SAVEDRAFT](types.UI_BUTTON.md#savedraft)
+- [STARTCONFIGURE](types.UI_BUTTON.md#startconfigure)
+
+## Enumeration members
+
+### ADDONS
+
+• **ADDONS** = `"addons"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L15)
+
+___
+
+### AR
+
+• **AR** = `"ar"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:8](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L8)
+
+___
+
+### DIMENSIONS
+
+• **DIMENSIONS** = `"dimensions"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:11](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L11)
+
+___
+
+### EXPORT\_3D
+
+• **EXPORT\_3D** = `"export3d"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:21](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L21)
+
+___
+
+### FULLSCREEN
+
+• **FULLSCREEN** = `"fullscreen"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:12](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L12)
+
+___
+
+### MULTISELECT
+
+• **MULTISELECT** = `"multiselect"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:10](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L10)
+
+___
+
+### PARTLIST
+
+• **PARTLIST** = `"partlist"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L9)
+
+___
+
+### PAUSECONFIGURE
+
+• **PAUSECONFIGURE** = `"pauseconfigure"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:20](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L20)
+
+___
+
+### RENDERIMAGE
+
+• **RENDERIMAGE** = `"renderimage"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:14](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L14)
+
+___
+
+### REQUESTPLAN
+
+• **REQUESTPLAN** = `"requestplan"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:17](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L17)
+
+___
+
+### REQUESTPRODUCT
+
+• **REQUESTPRODUCT** = `"requestproduct"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:16](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L16)
+
+___
+
+### RESETCAMERA
+
+• **RESETCAMERA** = `"resetcamera"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:13](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L13)
+
+___
+
+### ROTATE
+
+• **ROTATE** = `"rotate"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:22](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L22)
+
+___
+
+### SAVEDRAFT
+
+• **SAVEDRAFT** = `"savedraft"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:18](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L18)
+
+___
+
+### STARTCONFIGURE
+
+• **STARTCONFIGURE** = `"startconfigure"`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:19](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L19)

package/docs/api/interfaces/exposed_callbacks.Labels.md

@@ -0,0 +1,32 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Labels
+
+# Interface: Labels
+
+[exposed-callbacks](../modules/exposed_callbacks.md).Labels
+
+## Table of contents
+
+### Properties
+
+- [catalogLabel](exposed_callbacks.Labels.md#cataloglabel)
+- [label](exposed_callbacks.Labels.md#label)
+
+## Properties
+
+### catalogLabel
+
+• **catalogLabel**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:14](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L14)
+
+___
+
+### label
+
+• **label**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L15)

package/docs/api/interfaces/exposed_callbacks.Price.md

@@ -0,0 +1,32 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Price
+
+# Interface: Price
+
+[exposed-callbacks](../modules/exposed_callbacks.md).Price
+
+## Table of contents
+
+### Properties
+
+- [currencySymbol](exposed_callbacks.Price.md#currencysymbol)
+- [price](exposed_callbacks.Price.md#price)
+
+## Properties
+
+### currencySymbol
+
+• **currencySymbol**: `Nullable`<`string`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L9)
+
+___
+
+### price
+
+• **price**: `Nullable`<`number`\>
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:10](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L10)

package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md

@@ -0,0 +1,58 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / RoomleEmbeddingApiKeys
+
+# Interface: RoomleEmbeddingApiKeys
+
+[roomle-configurator-api](../modules/roomle_configurator_api.md).RoomleEmbeddingApiKeys
+
+## Implemented by
+
+- [`default`](../classes/roomle_configurator_api.default.md)
+
+## Table of contents
+
+### Properties
+
+- [analytics](roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
+- [extended](roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
+- [global](roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
+- [ui](roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
+
+## Properties
+
+### analytics
+
+• **analytics**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:65](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L65)
+
+___
+
+### extended
+
+• **extended**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L63)
+
+___
+
+### global
+
+• **global**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:66](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L66)
+
+___
+
+### ui
+
+• **ui**: `any`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:64](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L64)

package/docs/api/interfaces/types.ConfiguratorSettings.md

@@ -0,0 +1,150 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / ConfiguratorSettings
+
+# Interface: ConfiguratorSettings
+
+[types](../modules/types.md).ConfiguratorSettings
+
+## Hierarchy
+
+- `RapiConfiguratorSettings`
+
+  ↳ **`ConfiguratorSettings`**
+
+## Table of contents
+
+### Properties
+
+- [\_\_rapi\_path\_\_](types.ConfiguratorSettings.md#__rapi_path__)
+- [allowedHost](types.ConfiguratorSettings.md#allowedhost)
+- [allowedHosts](types.ConfiguratorSettings.md#allowedhosts)
+- [id](types.ConfiguratorSettings.md#id)
+- [isLocally](types.ConfiguratorSettings.md#islocally)
+- [links](types.ConfiguratorSettings.md#links)
+- [settings](types.ConfiguratorSettings.md#settings)
+- [tenant](types.ConfiguratorSettings.md#tenant)
+- [tenant\_id](types.ConfiguratorSettings.md#tenant_id)
+- [url](types.ConfiguratorSettings.md#url)
+
+## Properties
+
+### \_\_rapi\_path\_\_
+
+• `Optional` **\_\_rapi\_path\_\_**: `string`
+
+#### Inherited from
+
+RapiConfiguratorSettings.\_\_rapi\_path\_\_
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:28
+
+___
+
+### allowedHost
+
+• **allowedHost**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:140](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L140)
+
+___
+
+### allowedHosts
+
+• **allowedHosts**: `string`[]
+
+#### Inherited from
+
+RapiConfiguratorSettings.allowedHosts
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:422
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Overrides
+
+RapiConfiguratorSettings.id
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:139](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L139)
+
+___
+
+### isLocally
+
+• `Optional` **isLocally**: false \| true
+
+#### Inherited from
+
+RapiConfiguratorSettings.isLocally
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:27
+
+___
+
+### links
+
+• `Optional` **links**: `LinksCollection`
+
+#### Inherited from
+
+RapiConfiguratorSettings.links
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:30
+
+___
+
+### settings
+
+• **settings**: [`UiInitData`](types.UiInitData.md)
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:143](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L143)
+
+___
+
+### tenant
+
+• **tenant**: `number`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:141](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L141)
+
+___
+
+### tenant\_id
+
+• **tenant\_id**: `string`
+
+#### Inherited from
+
+RapiConfiguratorSettings.tenant\_id
+
+#### Defined in
+
+node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:423
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:142](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L142)

package/docs/api/interfaces/types.EmbeddingSkin.md

@@ -0,0 +1,65 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / EmbeddingSkin
+
+# Interface: EmbeddingSkin
+
+[types](../modules/types.md).EmbeddingSkin
+
+## Table of contents
+
+### Properties
+
+- [color-on-cta](types.EmbeddingSkin.md#color-on-cta)
+- [color-on-primary](types.EmbeddingSkin.md#color-on-primary)
+- [cta-color](types.EmbeddingSkin.md#cta-color)
+- [primary-color](types.EmbeddingSkin.md#primary-color)
+- [primary-color-in-rgb](types.EmbeddingSkin.md#primary-color-in-rgb)
+
+## Properties
+
+### color-on-cta
+
+• `Optional` **color-on-cta**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:135](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L135)
+
+___
+
+### color-on-primary
+
+• `Optional` **color-on-primary**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:133](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L133)
+
+___
+
+### cta-color
+
+• `Optional` **cta-color**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:134](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L134)
+
+___
+
+### primary-color
+
+• `Optional` **primary-color**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:131](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L131)
+
+___
+
+### primary-color-in-rgb
+
+• `Optional` **primary-color-in-rgb**: `string`
+
+#### Defined in
+
+[src/configurator/embedding/types.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L132)