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

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

@@ -0,0 +1,145 @@
+[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
+
+___
+
+### AR
+
+• **AR**: = "ar"
+
+Defined in: src/configurator/embedding/types.ts:8
+
+___
+
+### DIMENSIONS
+
+• **DIMENSIONS**: = "dimensions"
+
+Defined in: src/configurator/embedding/types.ts:11
+
+___
+
+### EXPORT\_3D
+
+• **EXPORT\_3D**: = "export3d"
+
+Defined in: src/configurator/embedding/types.ts:21
+
+___
+
+### FULLSCREEN
+
+• **FULLSCREEN**: = "fullscreen"
+
+Defined in: src/configurator/embedding/types.ts:12
+
+___
+
+### MULTISELECT
+
+• **MULTISELECT**: = "multiselect"
+
+Defined in: src/configurator/embedding/types.ts:10
+
+___
+
+### PARTLIST
+
+• **PARTLIST**: = "partlist"
+
+Defined in: src/configurator/embedding/types.ts:9
+
+___
+
+### PAUSECONFIGURE
+
+• **PAUSECONFIGURE**: = "pauseconfigure"
+
+Defined in: src/configurator/embedding/types.ts:20
+
+___
+
+### RENDERIMAGE
+
+• **RENDERIMAGE**: = "renderimage"
+
+Defined in: src/configurator/embedding/types.ts:14
+
+___
+
+### REQUESTPLAN
+
+• **REQUESTPLAN**: = "requestplan"
+
+Defined in: src/configurator/embedding/types.ts:17
+
+___
+
+### REQUESTPRODUCT
+
+• **REQUESTPRODUCT**: = "requestproduct"
+
+Defined in: src/configurator/embedding/types.ts:16
+
+___
+
+### RESETCAMERA
+
+• **RESETCAMERA**: = "resetcamera"
+
+Defined in: src/configurator/embedding/types.ts:13
+
+___
+
+### ROTATE
+
+• **ROTATE**: = "rotate"
+
+Defined in: src/configurator/embedding/types.ts:22
+
+___
+
+### SAVEDRAFT
+
+• **SAVEDRAFT**: = "savedraft"
+
+Defined in: src/configurator/embedding/types.ts:18
+
+___
+
+### STARTCONFIGURE
+
+• **STARTCONFIGURE**: = "startconfigure"
+
+Defined in: src/configurator/embedding/types.ts:19

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

@@ -0,0 +1,28 @@
+[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
+
+___
+
+### label
+
+• **label**: *Nullable*<string\>
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:15

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

@@ -0,0 +1,28 @@
+[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
+
+___
+
+### price
+
+• **price**: *Nullable*<number\>
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:10

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

@@ -0,0 +1,50 @@
+[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
+
+___
+
+### extended
+
+• **extended**: *any*
+
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:63
+
+___
+
+### global
+
+• **global**: *any*
+
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:66
+
+___
+
+### ui
+
+• **ui**: *any*
+
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:64

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

@@ -0,0 +1,118 @@
+[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
+
+___
+
+### 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
+
+___
+
+### isLocally
+
+• `Optional` **isLocally**: *boolean*
+
+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
+
+___
+
+### tenant
+
+• **tenant**: *number*
+
+Defined in: src/configurator/embedding/types.ts:141
+
+___
+
+### 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

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

@@ -0,0 +1,55 @@
+[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:134
+
+___
+
+### color-on-primary
+
+• `Optional` **color-on-primary**: *string*
+
+Defined in: src/configurator/embedding/types.ts:132
+
+___
+
+### cta-color
+
+• `Optional` **cta-color**: *string*
+
+Defined in: src/configurator/embedding/types.ts:133
+
+___
+
+### primary-color
+
+• `Optional` **primary-color**: *string*
+
+Defined in: src/configurator/embedding/types.ts:130
+
+___
+
+### primary-color-in-rgb
+
+• `Optional` **primary-color-in-rgb**: *string*
+
+Defined in: src/configurator/embedding/types.ts:131