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

package/docs/api/classes/{exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md → exposed_analytics_callbacks.exposedanalyticscallbacks.md}

@@ -8,23 +8,25 @@
 
 ### Constructors
 
-- [constructor](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#constructor)
+- [constructor](exposed_analytics_callbacks.exposedanalyticscallbacks.md#constructor)
 
 ### Methods
 
-- [onGATracking](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#ongatracking)
+- [onGATracking](exposed_analytics_callbacks.exposedanalyticscallbacks.md#ongatracking)
 
 ## Constructors
 
 ### constructor
 
-• **new ExposedAnalyticsCallbacks**()
+\+ **new ExposedAnalyticsCallbacks**(): [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md)
+
+**Returns:** [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md)
 
 ## Methods
 
 ### onGATracking
 
-▸ **onGATracking**(...`_args`): `void`
+▸ **onGATracking**(...`_args`: *any*[]): *void*
 
 Is called whenever something is sent to google analytics
 Possible parameters are everything which is possible in gtag.js
@@ -36,12 +38,8 @@ you can intercept events and send them to your own analytics tool
 
 | Name | Type |
 | :------ | :------ |
-| `..._args` | `any`[] |
-
-#### Returns
-
-`void`
+| `..._args` | *any*[] |
 
-#### Defined in
+**Returns:** *void*
 
-[src/configurator/embedding/exposed-analytics-callbacks.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/exposed-analytics-callbacks.ts#L9)
+Defined in: src/configurator/embedding/exposed-analytics-callbacks.ts:9

package/docs/api/classes/exposed_api.exposedapi.md

@@ -0,0 +1,191 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-api](../modules/exposed_api.md) / ExposedApi
+
+# Class: ExposedApi
+
+[exposed-api](../modules/exposed_api.md).ExposedApi
+
+## Table of contents
+
+### Constructors
+
+- [constructor](exposed_api.exposedapi.md#constructor)
+
+### Accessors
+
+- [callbacks](exposed_api.exposedapi.md#callbacks)
+
+### Methods
+
+- [giveGaConsent](exposed_api.exposedapi.md#givegaconsent)
+- [loadConfigurationString](exposed_api.exposedapi.md#loadconfigurationstring)
+- [loadObject](exposed_api.exposedapi.md#loadobject)
+- [pauseConfiguring](exposed_api.exposedapi.md#pauseconfiguring)
+- [setPrice](exposed_api.exposedapi.md#setprice)
+- [startConfiguring](exposed_api.exposedapi.md#startconfiguring)
+- [triggerRequestPlan](exposed_api.exposedapi.md#triggerrequestplan)
+- [triggerRequestProduct](exposed_api.exposedapi.md#triggerrequestproduct)
+
+## Constructors
+
+### constructor
+
+\+ **new ExposedApi**(`sdkConnector`: *SdkConnector*, `messageHandler`: ``null`` \| *MessageHandler*, `sdk`: *default* \| *default* \| *default*, `exposedCallbacks`: [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md), `store`: *Store*<StoreState\>, `analytics`: Analytics, `globalCallback`: *GlobalCallback*): [*ExposedApi*](exposed_api.exposedapi.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `sdkConnector` | *SdkConnector* |
+| `messageHandler` | ``null`` \| *MessageHandler* |
+| `sdk` | *default* \| *default* \| *default* |
+| `exposedCallbacks` | [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md) |
+| `store` | *Store*<StoreState\> |
+| `analytics` | Analytics |
+| `globalCallback` | *GlobalCallback* |
+
+**Returns:** [*ExposedApi*](exposed_api.exposedapi.md)
+
+Defined in: src/configurator/embedding/exposed-api.ts:27
+
+## Accessors
+
+### callbacks
+
+• get **callbacks**(): [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
+
+**Returns:** [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
+
+Defined in: src/configurator/embedding/exposed-api.ts:117
+
+## Methods
+
+### giveGaConsent
+
+▸ **giveGaConsent**(): *void*
+
+call this method if consent of Google Analytics is given later and not already in init-data on boot
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-api.ts:205
+
+___
+
+### loadConfigurationString
+
+▸ **loadConfigurationString**(`configurationString`: *string*): *Promise*<Nullable<LoadResponse\>\>
+
+call this method to load the configuration string you want into the 3d Scene
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `configurationString` | *string* | string of the configuration, starts with `{` and ends with `}` |
+
+**Returns:** *Promise*<Nullable<LoadResponse\>\>
+
+Defined in: src/configurator/embedding/exposed-api.ts:136
+
+___
+
+### loadObject
+
+▸ **loadObject**(`id`: *string*): *Promise*<Nullable<LoadResponse\>\>
+
+call this method to load the object you want into the 3d Scene
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | *string* | database ID of the object you want to load |
+
+**Returns:** *Promise*<Nullable<LoadResponse\>\>
+
+Defined in: src/configurator/embedding/exposed-api.ts:125
+
+___
+
+### pauseConfiguring
+
+▸ **pauseConfiguring**(): *void*
+
+This method can be used to pause configuration
+If the configurator was called in view-only mode
+this method triggers the onBackToWebsite callback.
+To know when the view-only mode is activated see the
+description of the startConfiguring method
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-api.ts:173
+
+___
+
+### setPrice
+
+▸ **setPrice**(`currencySymbol`: *string*, `price`: *number*): *void*
+
+set the price for the UI to show
+most likely needed when implementing your own price service
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `currencySymbol` | *string* |
+| `price` | *number* |
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-api.ts:150
+
+___
+
+### startConfiguring
+
+▸ **startConfiguring**(): *void*
+
+This method can be used to start configuration when
+3d scene is only initialized as viewer first, the
+configurator is automatically instantiated as viewer
+if the container where the configurator is placed is
+smaller than 1024px (this breakpoint could change in future)
+so do not rely on this exact pixel setting
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-api.ts:162
+
+___
+
+### triggerRequestPlan
+
+▸ **triggerRequestPlan**(): *Promise*<void\>
+
+call this method to trigger the onRequestPlan event from
+outside of the iframe. When this method is called the same
+process is kicked off as if the user would have clicked on
+request plan. Therefore you can just use the same callback
+to react on the response
+
+**Returns:** *Promise*<void\>
+
+Defined in: src/configurator/embedding/exposed-api.ts:198
+
+___
+
+### triggerRequestProduct
+
+▸ **triggerRequestProduct**(): *Promise*<void\>
+
+call this method to trigger the onRequestProduct event from
+outside of the iframe. When this method is called the same
+process is kicked off as if the user would have clicked on
+request product. Therefore you can just use the same callback
+to react on the response
+
+**Returns:** *Promise*<void\>
+
+Defined in: src/configurator/embedding/exposed-api.ts:187

package/docs/api/classes/exposed_callbacks.exposedcallbacks.md

@@ -0,0 +1,145 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / ExposedCallbacks
+
+# Class: ExposedCallbacks
+
+[exposed-callbacks](../modules/exposed_callbacks.md).ExposedCallbacks
+
+## Table of contents
+
+### Constructors
+
+- [constructor](exposed_callbacks.exposedcallbacks.md#constructor)
+
+### Methods
+
+- [onBackToWebsite](exposed_callbacks.exposedcallbacks.md#onbacktowebsite)
+- [onButtonClicked](exposed_callbacks.exposedcallbacks.md#onbuttonclicked)
+- [onPartListUpdate](exposed_callbacks.exposedcallbacks.md#onpartlistupdate)
+- [onRequestPlan](exposed_callbacks.exposedcallbacks.md#onrequestplan)
+- [onRequestProduct](exposed_callbacks.exposedcallbacks.md#onrequestproduct)
+- [onResize](exposed_callbacks.exposedcallbacks.md#onresize)
+- [onUseFullPage](exposed_callbacks.exposedcallbacks.md#onusefullpage)
+
+## Constructors
+
+### constructor
+
+\+ **new ExposedCallbacks**(): [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
+
+**Returns:** [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
+
+## Methods
+
+### onBackToWebsite
+
+▸ **onBackToWebsite**(): *void*
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:40
+
+___
+
+### onButtonClicked
+
+▸ **onButtonClicked**(`name`: [*UI\_BUTTON*](../enums/types.ui_button.md)): *boolean* \| *void* \| *Promise*<boolean\>
+
+Gets called when a button in the UI is clicked
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | [*UI\_BUTTON*](../enums/types.ui_button.md) |
+
+**Returns:** *boolean* \| *void* \| *Promise*<boolean\>
+
+overrideEventBehaviour true if the event has been consumed and it should not trigger default behaviour, undefined or false otherwise
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:47
+
+___
+
+### onPartListUpdate
+
+▸ **onPartListUpdate**(`partList`: KernelPartList, `hash`: *string*): *void*
+
+fullList fullList (needed for price calculation) of the current configuration
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `partList` | KernelPartList | the part list with all details, grouped, etc |
+| `hash` | *string* | - |
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:34
+
+___
+
+### onRequestPlan
+
+▸ **onRequestPlan**(`planId`: *string*, `image`: Base64Image, `items`: *any*[]): *void*
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `planId` | *string* |
+| `image` | Base64Image |
+| `items` | *any*[] |
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:49
+
+___
+
+### onRequestProduct
+
+▸ **onRequestProduct**(`configurationId`: *string*, `image`: Base64Image, `partList`: KernelPartList, `price`: [*Price*](../interfaces/exposed_callbacks.price.md), `labels`: [*Labels*](../interfaces/exposed_callbacks.labels.md), `configuration`: RapiConfigurationEnhanced): *void*
+
+Returns all necessary params when 'Request Product'/'Checkout' button has pressed
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `configurationId` | *string* | id of the current configuration |
+| `image` | Base64Image | image of the current configuration |
+| `partList` | KernelPartList | the part list with all details, grouped, etc |
+| `price` | [*Price*](../interfaces/exposed_callbacks.price.md) | price of the current configuration, either set via setPrice or from Roomle price service |
+| `labels` | [*Labels*](../interfaces/exposed_callbacks.labels.md) | the label of the catalog and the furniture system |
+| `configuration` | RapiConfigurationEnhanced | the data returned from the Roomle backend |
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:28
+
+___
+
+### onResize
+
+▸ **onResize**(`isDesktop`: *boolean*): *void*
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `isDesktop` | *boolean* |
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:36
+
+___
+
+### onUseFullPage
+
+▸ **onUseFullPage**(): *void*
+
+**Returns:** *void*
+
+Defined in: src/configurator/embedding/exposed-callbacks.ts:38

package/docs/api/classes/roomle_configurator_api.default.md

@@ -13,7 +13,7 @@
 
 ## Implements
 
-- [`RoomleEmbeddingApiKeys`](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md)
+- [*RoomleEmbeddingApiKeys*](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md)
 
 ## Table of contents
 
@@ -36,89 +36,69 @@
 
 ### analytics
 
-• **analytics**: `Object`
+• **analytics**: *object*
 
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `callbacks` | [`ExposedAnalyticsCallbacks`](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md) |
+| `callbacks` | [*ExposedAnalyticsCallbacks*](exposed_analytics_callbacks.exposedanalyticscallbacks.md) |
 
-#### Implementation of
+Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[analytics](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#analytics)
 
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[analytics](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
-
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:140](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L140)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:140
 
 ___
 
 ### extended
 
-• **extended**: `SdkType`
-
-#### Implementation of
+• **extended**: SdkType
 
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[extended](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
+Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[extended](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#extended)
 
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:136](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L136)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:136
 
 ___
 
 ### global
 
-• **global**: `Object`
+• **global**: *object*
 
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `callbacks` | `GlobalCallback` |
-
-#### Implementation of
+| `callbacks` | *GlobalCallback* |
 
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[global](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
+Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[global](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#global)
 
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:144](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L144)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:144
 
 ___
 
 ### ui
 
-• **ui**: [`ExposedApi`](exposed_api.ExposedApi.md)
-
-#### Implementation of
+• **ui**: [*ExposedApi*](exposed_api.exposedapi.md)
 
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[ui](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
+Implementation of: [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md).[ui](../interfaces/roomle_configurator_api.roomleembeddingapikeys.md#ui)
 
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L132)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:132
 
 ## Methods
 
 ### teardown
 
-▸ **teardown**(): `void`
-
-#### Returns
+▸ **teardown**(): *void*
 
-`void`
+**Returns:** *void*
 
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:206](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L206)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:206
 
 ___
 
 ### create
 
-▸ `Static` **create**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+▸ `Static` **create**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
 
 Method to create a new instance of a Roomle Configurator
 
@@ -128,23 +108,19 @@ Method to create a new instance of a Roomle Configurator
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-
-#### Returns
-
-`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+| `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
+| `container` | HTMLElement | DOM container in which the configurator should be placed |
+| `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
 
-#### Defined in
+**Returns:** *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
 
-[src/configurator/embedding/roomle-configurator-api.ts:96](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L96)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:96
 
 ___
 
 ### createConfigurator
 
-▸ `Static` **createConfigurator**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+▸ `Static` **createConfigurator**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
 
 Method to create a new instance of a Roomle Configurator
 
@@ -152,45 +128,37 @@ Method to create a new instance of a Roomle Configurator
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-
-#### Returns
-
-`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
+| `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
+| `container` | HTMLElement | DOM container in which the configurator should be placed |
+| `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
 
-#### Defined in
+**Returns:** *Promise*<[*RoomleConfiguratorApi*](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
 
-[src/configurator/embedding/roomle-configurator-api.ts:85](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L85)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:85
 
 ___
 
 ### createPlanner
 
-▸ `Static` **createPlanner**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
+▸ `Static` **createPlanner**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomlePlannerApi*](../modules/roomle_configurator_api.md#roomleplannerapi)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `configuratorId` | `string` |
-| `container` | `HTMLElement` |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) |
+| `configuratorId` | *string* |
+| `container` | HTMLElement |
+| `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) |
 
-#### Returns
+**Returns:** *Promise*<[*RoomlePlannerApi*](../modules/roomle_configurator_api.md#roomleplannerapi)\>
 
-`Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
-
-#### Defined in
-
-[src/configurator/embedding/roomle-configurator-api.ts:75](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L75)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:75
 
 ___
 
 ### createViewer
 
-▸ `Static` **createViewer**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
+▸ `Static` **createViewer**(`configuratorId`: *string*, `container`: HTMLElement, `initData`: [*UiInitData*](../interfaces/types.uiinitdata.md)): *Promise*<[*RoomleViewerApi*](../modules/roomle_configurator_api.md#roomleviewerapi)\>
 
 Method to create a new instance of a Roomle Viewer
 
@@ -198,14 +166,10 @@ Method to create a new instance of a Roomle Viewer
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-
-#### Returns
-
-`Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
+| `configuratorId` | *string* | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
+| `container` | HTMLElement | DOM container in which the configurator should be placed |
+| `initData` | [*UiInitData*](../interfaces/types.uiinitdata.md) | settings with which the configurator should be started |
 
-#### Defined in
+**Returns:** *Promise*<[*RoomleViewerApi*](../modules/roomle_configurator_api.md#roomleviewerapi)\>
 
-[src/configurator/embedding/roomle-configurator-api.ts:106](https://gitlab.com/roomle/web/roomle-ui/-/blob/fb7c6a6b/src/configurator/embedding/roomle-configurator-api.ts#L106)
+Defined in: src/configurator/embedding/roomle-configurator-api.ts:106