@omni-co/embed 0.18.0 → 0.20.0

package/README.md

@@ -31,35 +31,35 @@ import {
   embedSsoDashboard,
   embedSsoWorkbook,
   embedSsoContentDiscovery,
-} from "@omni-co/embed";
+} from '@omni-co/embed'
 
 // This creates a signed embed sso link for a dashboard
 // in the omni account named Acme.
 const iframeUrl = await embedSsoDashboard({
-  contentId: "miU0hL6z",
-  externalId: "wile.e@coyote.co",
-  name: "Wile E",
-  organizationName: "acme",
-  secret: "abcdefghijklmnopqrstuvwxyz123456",
-});
+  contentId: 'miU0hL6z',
+  externalId: 'wile.e@coyote.co',
+  name: 'Wile E',
+  organizationName: 'acme',
+  secret: 'abcdefghijklmnopqrstuvwxyz123456',
+})
 
 // Alternatively, you can create a signed embed sso link for a workbook.
 const iframeUrl = await embedSsoWorkbook({
-  contentId: "miU0hL6z",
-  externalId: "wile.e@coyote.co",
-  name: "Wile E",
-  organizationName: "acme",
-  secret: "abcdefghijklmnopqrstuvwxyz123456",
-});
+  contentId: 'miU0hL6z',
+  externalId: 'wile.e@coyote.co',
+  name: 'Wile E',
+  organizationName: 'acme',
+  secret: 'abcdefghijklmnopqrstuvwxyz123456',
+})
 
 // You can also create a signed embed sso link for a content discovery page.
 const iframeUrl = await embedSsoContentDiscovery({
-  externalId: "wile.e@coyote.co",
-  name: "Wile E",
-  path: "root",
-  organizationName: "acme",
-  secret: "abcdefghijklmnopqrstuvwxyz123456",
-});
+  externalId: 'wile.e@coyote.co',
+  name: 'Wile E',
+  path: 'root',
+  organizationName: 'acme',
+  secret: 'abcdefghijklmnopqrstuvwxyz123456',
+})
 ```
 
 ## 2-step Example
@@ -100,12 +100,12 @@ const redeemSessionUrl = await redeemSessionToken({
 // Use `host` to create a link to a vanity domain.
 // Note: `organizationName` and `domain` are incompatible with `host`
 const iframeUrl = await embedSsoDashboard({
-  contentId: "miU0hL6z",
-  externalId: "wile.e@coyote.co",
-  host: "omni.example.com",
-  name: "Wile E",
-  secret: "abcdefghijklmnopqrstuvwxyz123456",
-});
+  contentId: 'miU0hL6z',
+  externalId: 'wile.e@coyote.co',
+  host: 'omni.example.com',
+  name: 'Wile E',
+  secret: 'abcdefghijklmnopqrstuvwxyz123456',
+})
 ```
 
 ## embedSsoDashboard
@@ -115,32 +115,32 @@ This is the type signature for the `embedSsoDashboard` function:
 ```ts
 type EmbedSsoDashboardProps = {
   // Optional boolean property that toggles the dashboard's Access Boost setting.
-  accessBoost?: boolean;
+  accessBoost?: boolean
 
   // Optional object that determines the connection permissions for the embed user.
-  connectionRoles?: Record<string, EmbedConnectionRoles>;
+  connectionRoles?: Record<string, EmbedConnectionRoles>
 
   // Short GUID of the dashboard. Can be obtained via the dashboard's url.
-  contentId: string;
+  contentId: string
 
   // Optional custom theme object that styles the embedded dashboard.
-  customTheme?: CustomThemeProperties;
+  customTheme?: CustomThemeProperties
 
   /**
    * Optional custom theme ID setting that styles the embedded dashboard.
    * This ID should be from a theme created within the Omni application.
    */
-  customThemeId?: string;
+  customThemeId?: string
 
   // Optional email parameter that sets the default scheduling email for the embed user.
-  email?: string;
+  email?: string
 
   /**
    * Optional identifier to associate the user with an external organization or system.
    * Note that each distinct entity will generate its own folder and group. These can be used by
    * an embed user to share content with other members in the same entity.
    */
-  entity?: string;
+  entity?: string
 
   /**
    * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -153,7 +153,7 @@ type EmbedSsoDashboardProps = {
    *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
    *  to the top-level entity folder.
    */
-  entityFolderContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderContentRole?: EmbedEntityFolderContentRoles
 
   /**
    * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -164,22 +164,22 @@ type EmbedSsoDashboardProps = {
    * VIEWER: all users in the group are restricted to just view content in the entity folder.
    * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
    */
-  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles
 
   // Required identifier to associate the external user with an automatically generated internal Omni user.
-  externalId: string;
+  externalId: string
 
   /**
    * Optional url filter search parameter. Should be the same as the filter search parameters on a dashboard url.
    * Example: f--inventory_items.cost=%7B"kind"%3A"EQUALS"%2C"type"%3A"number"%2C"values"%3A%5B%5D%2C"is_negative"%3Afalse%2C"is_inclusive"%3Afalse%7D&f--users.state=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"Aberdeen"%2C"Alabama"%5D%2C"is_negative"%3Afalse%7D&f--users.country=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"UK"%5D%2C"is_negative"%3Afalse%7D
    *
    */
-  filterSearchParam?: string;
+  filterSearchParam?: string
 
   /*
    * Optional groups array property. The array should be a list of group names from the Omni application, which the embed user will be added to.
    */
-  groups?: string[];
+  groups?: string[]
 
   /**
    * Used to set the host of signed embed URL, required when using vanity domains.
@@ -190,7 +190,7 @@ type EmbedSsoDashboardProps = {
    * @example "omni.example.com"
    * @example "omni.another-example.app"
    */
-  host?: string;
+  host?: string
 
   /**
    * Optional link access setting to control which Omni dashboard links are shown. Note that regardless of the linkAccess value,
@@ -200,7 +200,7 @@ type EmbedSsoDashboardProps = {
    * "abcd1234,efgh5678,ijkl9999": An allowlist of dashboard IDs that permisses and shows links to the specified dashboards.
    * undefined: If left undefined, the default behavior is to hide and disallow all links to other Omni dashboards on the embedded dashboard.
    */
-  linkAccess?: string;
+  linkAccess?: string
 
   /**
    * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
@@ -208,13 +208,13 @@ type EmbedSsoDashboardProps = {
    * APPLICATION: the entire application will be embedded, meaning in-app navigation and document header options will be available.
    * SINGLE_CONTENT: only the content specified in the contentId will be embedded and application mode features will be hidden.
    */
-  mode?: EmbedSessionMode;
+  mode?: EmbedSessionMode
 
   // Optional object that determines the model permissions for the embed user.
-  modelRoles?: Record<string, EmbedConnectionRoles>;
+  modelRoles?: Record<string, EmbedConnectionRoles>
 
   // Required name of the external user.
-  name: string;
+  name: string
 
   /**
    * Name of the organization the content belongs to. If provided, generates a default embed host
@@ -222,36 +222,36 @@ type EmbedSsoDashboardProps = {
    *
    * @throws Error if `host` is provided.
    */
-  organizationName?: string;
+  organizationName?: string
 
   // Port of host.
-  port?: number;
+  port?: number
 
   // Optional dark mode setting. Can be one of "true", "false", or "system".
-  prefersDark?: string;
+  prefersDark?: string
 
   /**
    * When true, an existing content role for the embed user on the entity folder will not be overwritten
    * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
    * the `entityFolderContentRole` value will be applied.
    */
-  preserveEntityFolderContentRole?: boolean;
+  preserveEntityFolderContentRole?: boolean
 
   // Signing secret available to Omni admins.
-  secret: string;
+  secret: string
 
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
-  theme?: string;
+  theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>;
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
    * externalId. User attributes must be created in Omni before being
    * defined and given a value here.
    */
-  userAttributes?: Record<string, string | string[] | number | number[]>;
+  userAttributes?: Record<string, string | string[] | number | number[]>
 
   // DEPRECATED
 
@@ -261,8 +261,8 @@ type EmbedSsoDashboardProps = {
    *
    * @throws Error if `host` is provided.
    */
-  domain?: string;
-};
+  domain?: string
+}
 ```
 
 ## embedSsoWorkbook
@@ -272,7 +272,7 @@ This is the type signature for the `embedSsoWorkbook` function:
 ```ts
 type EmbedSsoWorkbookProps = {
   // Optional object that determines the connection permissions for the embed user.
-  connectionRoles?: Record<string, EmbedConnectionRoles>;
+  connectionRoles?: Record<string, EmbedConnectionRoles>
 
   /**
    * Short GUID of the workbook.
@@ -280,29 +280,29 @@ type EmbedSsoWorkbookProps = {
    * Can be obtained via the workbook's share -> embed -> iframe url or via the dashboard url.
    * This will embed the workbook associated with the dashboard id.
    */
-  contentId: string;
+  contentId: string
 
   /**
    * Optional custom theme object. Note that this theme will only apply to dashboards viewed
    * during the generated embed session.
    */
-  customTheme?: CustomThemeProperties;
+  customTheme?: CustomThemeProperties
 
   /**
    * Optional custom theme ID setting. Note that this theme will only apply to dashboards viewed
    * during the generated embed session.
    */
-  customThemeId?: string;
+  customThemeId?: string
 
   // Optional email parameter that sets the default scheduling email for the embed user.
-  email?: string;
+  email?: string
 
   /**
    * Optional identifier to associate the user with an external organization or system.
    * Note that each distinct entity will generate its own folder and group. These can be used by
    * an embed user to share content with other members in the same entity.
    */
-  entity?: string;
+  entity?: string
 
   /**
    * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -315,7 +315,7 @@ type EmbedSsoWorkbookProps = {
    *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
    *  to the top-level entity folder.
    */
-  entityFolderContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderContentRole?: EmbedEntityFolderContentRoles
 
   /**
    * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -326,16 +326,16 @@ type EmbedSsoWorkbookProps = {
    * VIEWER: all users in the group are restricted to just view content in the entity folder.
    * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
    */
-  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles
 
   // Required identifier to associate the external user with an
   // automatically generated internal Omni user.
-  externalId: string;
+  externalId: string
 
   /*
    * Optional groups array property. The array should be a list of group names from the Omni application, which the embed user will be added to.
    */
-  groups?: string[];
+  groups?: string[]
 
   /**
    * Used to set the host of signed embed URL, required when using vanity domains.
@@ -346,7 +346,7 @@ type EmbedSsoWorkbookProps = {
    * @example "omni.example.com"
    * @example "omni.another-example.app"
    */
-  host?: string;
+  host?: string
 
   /**
    * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
@@ -354,13 +354,13 @@ type EmbedSsoWorkbookProps = {
    * APPLICATION: the entire application will be embedded, meaning in-app navigation and document header options will be available.
    * SINGLE_CONTENT: only the content specified in the contentId will be embedded and application mode features will be hidden.
    */
-  mode?: EmbedSessionMode;
+  mode?: EmbedSessionMode
 
   // Optional object that determines the model permissions for the embed user.
-  modelRoles?: Record<string, EmbedConnectionRoles>;
+  modelRoles?: Record<string, EmbedConnectionRoles>
 
   // Required name of the external user.
-  name: string;
+  name: string
 
   /**
    * Name of the organization the content belongs to. If provided, generates a default embed host
@@ -368,36 +368,36 @@ type EmbedSsoWorkbookProps = {
    *
    * @throws Error if `host` is provided.
    */
-  organizationName?: string;
+  organizationName?: string
 
   // Port of host.
-  port?: number;
+  port?: number
 
   // Optional dark mode setting. Can be one of "true", "false", or "system".
-  prefersDark?: string;
+  prefersDark?: string
 
   /**
    * When true, an existing content role for the embed user on the entity folder will not be overwritten
    * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
    * the `entityFolderContentRole` value will be applied.
    */
-  preserveEntityFolderContentRole?: boolean;
+  preserveEntityFolderContentRole?: boolean
 
   // Signing secret available to Omni admins.
-  secret: string;
+  secret: string
 
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
-  theme?: string;
+  theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>;
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
    * externalId. User attributes must be created in Omni before being
    * defined and given a value here.
    */
-  userAttributes?: Record<string, string | string[] | number | number[]>;
+  userAttributes?: Record<string, string | string[] | number | number[]>
 
   // DEPRECATED
 
@@ -407,8 +407,8 @@ type EmbedSsoWorkbookProps = {
    *
    * @throws Error if `host` is provided.
    */
-  domain?: string;
-};
+  domain?: string
+}
 ```
 
 ## embedSsoContentDiscovery
@@ -418,29 +418,29 @@ This is the type signature for the `embedSsoContentDiscovery` function:
 ```ts
 type EmbedSsoContentDiscoveryProps = {
   // Optional object that determines the connection permissions for the embed user.
-  connectionRoles?: Record<string, EmbedConnectionRoles>;
+  connectionRoles?: Record<string, EmbedConnectionRoles>
 
   /**
    * Optional custom theme object. Note that this theme will only apply to dashboards viewed
    * during the generated embed session.
    */
-  customTheme?: CustomThemeProperties;
+  customTheme?: CustomThemeProperties
 
   /**
    * Optional custom theme ID setting. Note that this theme will only apply to dashboards viewed
    * during the generated embed session.
    */
-  customThemeId?: string;
+  customThemeId?: string
 
   // Optional email parameter that sets the default scheduling email for the embed user.
-  email?: string;
+  email?: string
 
   /**
    * Optional identifier to associate the user with an external organization or system.
    * Note that each distinct entity will generate its own folder and group. These can be used by
    * an embed user to share content with other members in the same entity.
    */
-  entity?: string;
+  entity?: string
 
   /**
    * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -453,7 +453,7 @@ type EmbedSsoContentDiscoveryProps = {
    *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
    *  to the top-level entity folder.
    */
-  entityFolderContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderContentRole?: EmbedEntityFolderContentRoles
 
   /**
    * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -464,16 +464,16 @@ type EmbedSsoContentDiscoveryProps = {
    * VIEWER: all users in the group are restricted to just view content in the entity folder.
    * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
    */
-  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles
 
   // Required identifier to associate the external user with an
   // automatically generated internal Omni user.
-  externalId: string;
+  externalId: string
 
   /*
    * Optional groups array property. The array should be a list of group names from the Omni application, which the embed user will be added to.
    */
-  groups?: string[];
+  groups?: string[]
 
   /**
    * Used to set the host of signed embed URL, required when using vanity domains.
@@ -484,7 +484,7 @@ type EmbedSsoContentDiscoveryProps = {
    * @example "omni.example.com"
    * @example "omni.another-example.app"
    */
-  host?: string;
+  host?: string
 
   /**
    * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
@@ -492,13 +492,13 @@ type EmbedSsoContentDiscoveryProps = {
    * APPLICATION: the entire application will be embedded, meaning in-app navigation and document header options will be available.
    * SINGLE_CONTENT: only the content specified in the contentId will be embedded and application mode features will be hidden.
    */
-  mode?: EmbedSessionMode;
+  mode?: EmbedSessionMode
 
   // Optional object that determines the model permissions for the embed user.
-  modelRoles?: Record<string, EmbedConnectionRoles>;
+  modelRoles?: Record<string, EmbedConnectionRoles>
 
   // Required name of the external user.
-  name: string;
+  name: string
 
   /**
    * Name of the organization the content belongs to. If provided, generates a default embed host
@@ -506,7 +506,7 @@ type EmbedSsoContentDiscoveryProps = {
    *
    * @throws Error if `host` is provided.
    */
-  organizationName?: string;
+  organizationName?: string
 
   /**
    * Required path property. The path value determines the starting content discovery page
@@ -516,36 +516,36 @@ type EmbedSsoContentDiscoveryProps = {
    * entity-folder: embed entity folder
    * root: "Hub" page
    */
-  path: string;
+  path: string
 
   // Port of host.
-  port?: number;
+  port?: number
 
   // Optional dark mode setting. Can be one of "true", "false", or "system".
-  prefersDark?: string;
+  prefersDark?: string
 
   /**
    * When true, an existing content role for the embed user on the entity folder will not be overwritten
    * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
    * the `entityFolderContentRole` value will be applied.
    */
-  preserveEntityFolderContentRole?: boolean;
+  preserveEntityFolderContentRole?: boolean
 
   // Signing secret available to Omni admins.
-  secret: string;
+  secret: string
 
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
-  theme?: string;
+  theme?: string
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>;
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
    * externalId. User attributes must be created in Omni before being
    * defined and given a value here.
    */
-  userAttributes?: Record<string, string | string[] | number | number[]>;
+  userAttributes?: Record<string, string | string[] | number | number[]>
 
   // DEPRECATED
 
@@ -555,8 +555,8 @@ type EmbedSsoContentDiscoveryProps = {
    *
    * @throws Error if `host` is provided.
    */
-  domain?: string;
-};
+  domain?: string
+}
 ```
 
 ## createSessionToken
@@ -566,35 +566,35 @@ This is the type signature for the `createSessionToken` function:
 ```ts
 type CreateSessionTokenProps = {
   // Optional boolean property that toggles the dashboard's Access Boost setting.
-  accessBoost?: boolean;
+  accessBoost?: boolean
 
   // An Omni API key used for authentication purposes. Can be generated in your Omni application in the Admin > API Keys section.
-  apiKey: string;
+  apiKey: string
 
   // Optional object that determines the connection permissions for the embed user.
-  connectionRoles?: Record<string, EmbedConnectionRoles>;
+  connectionRoles?: Record<string, EmbedConnectionRoles>
 
   // Short GUID of the dashboard. Can be obtained via the dashboard's url.
-  contentId: string;
+  contentId: string
 
   // Optional custom theme object that styles the embedded dashboard.
-  customTheme?: CustomThemeProperties;
+  customTheme?: CustomThemeProperties
 
   /**
    * Optional custom theme ID setting that styles the embedded dashboard.
    * This ID should be from a theme created within the Omni application.
    */
-  customThemeId?: string;
+  customThemeId?: string
 
   // Optional email parameter that sets the default scheduling email for the embed user.
-  email?: string;
+  email?: string
 
   /**
    * Optional identifier to associate the user with an external organization or system.
    * Note that each distinct entity will generate its own folder and group. These can be used by
    * an embed user to share content with other members in the same entity.
    */
-  entity?: string;
+  entity?: string
 
   /**
    * Sets embed user content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -607,7 +607,7 @@ type CreateSessionTokenProps = {
    *  entityFolderGroupContentRole should also be set to NO_ACCESS in order to completely restrict access
    *  to the top-level entity folder.
    */
-  entityFolderContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderContentRole?: EmbedEntityFolderContentRoles
 
   /**
    * Sets embed entity group content permission on the entity folder. Can be one of "MANAGER", "EDITOR", "VIEWER",
@@ -618,22 +618,22 @@ type CreateSessionTokenProps = {
    * VIEWER: all users in the group are restricted to just view content in the entity folder.
    * NO_ACCESS: all users in the group will have no access to content in the top-level entity folder.
    */
-  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles;
+  entityFolderGroupContentRole?: EmbedEntityFolderContentRoles
 
   // Required identifier to associate the external user with an automatically generated internal Omni user.
-  externalId: string;
+  externalId: string
 
   /**
    * Optional url filter search parameter. Should be the same as the filter search parameters on a dashboard url.
    * Example: f--inventory_items.cost=%7B"kind"%3A"EQUALS"%2C"type"%3A"number"%2C"values"%3A%5B%5D%2C"is_negative"%3Afalse%2C"is_inclusive"%3Afalse%7D&f--users.state=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"Aberdeen"%2C"Alabama"%5D%2C"is_negative"%3Afalse%7D&f--users.country=%7B"kind"%3A"EQUALS"%2C"type"%3A"string"%2C"values"%3A%5B"UK"%5D%2C"is_negative"%3Afalse%7D
    *
    */
-  filterSearchParam?: string;
+  filterSearchParam?: string
 
   /*
    * Optional groups array property. The array should be a list of group names from the Omni application, which the embed user will be added to.
    */
-  groups?: string[];
+  groups?: string[]
 
   /**
    * Used to set the host of signed embed URL, required when using vanity domains.
@@ -644,7 +644,7 @@ type CreateSessionTokenProps = {
    * @example "omni.example.com"
    * @example "omni.another-example.app"
    */
-  host?: string;
+  host?: string
 
   /**
    * Optional link access setting to control which Omni dashboard links are shown. Note that regardless of the linkAccess value,
@@ -654,7 +654,7 @@ type CreateSessionTokenProps = {
    * "abcd1234,efgh5678,ijkl9999": An allowlist of dashboard IDs that permisses and shows links to the specified dashboards.
    * undefined: If left undefined, the default behavior is to hide and disallow all links to other Omni dashboards on the embedded dashboard.
    */
-  linkAccess?: string;
+  linkAccess?: string
 
   /**
    * Optional mode setting that determines whether the entire application should be embedded or a single piece of content.
@@ -662,13 +662,13 @@ type CreateSessionTokenProps = {
    * APPLICATION: the entire application will be embedded, meaning in-app navigation and document header options will be available.
    * SINGLE_CONTENT: only the content specified in the contentId will be embedded and application mode features will be hidden.
    */
-  mode?: EmbedSessionMode;
+  mode?: EmbedSessionMode
 
   // Optional object that determines the model permissions for the embed user.
-  modelRoles?: Record<string, EmbedConnectionRoles>;
+  modelRoles?: Record<string, EmbedConnectionRoles>
 
   // Required name of the external user.
-  name: string;
+  name: string
 
   /**
    * Name of the organization the content belongs to. If provided, generates a default embed host
@@ -676,27 +676,27 @@ type CreateSessionTokenProps = {
    *
    * @throws Error if `host` is provided.
    */
-  organizationName?: string;
+  organizationName?: string
 
   // Port of host.
-  port?: number;
+  port?: number
 
   /**
    * When true, an existing content role for the embed user on the entity folder will not be overwritten
    * by the `entityFolderContentRole` value. If a content role does not exist on the entity folder for the embed user,
    * the `entityFolderContentRole` value will be applied.
    */
-  preserveEntityFolderContentRole?: boolean;
+  preserveEntityFolderContentRole?: boolean
 
   // Optional UI settings object to control appearance of embed experience.
-  uiSettings?: Record<EmbedUiSettings, boolean>;
+  uiSettings?: EmbedUiSettingsObject
 
   /**
    * Optional user attributes to be passed to user associated with the
    * externalId. User attributes must be created in Omni before being
    * defined and given a value here.
    */
-  userAttributes?: Record<string, string | string[] | number | number[]>;
+  userAttributes?: Record<string, string | string[] | number | number[]>
 
   // DEPRECATED
 
@@ -706,8 +706,8 @@ type CreateSessionTokenProps = {
    *
    * @throws Error if `host` is provided.
    */
-  domain?: string;
-};
+  domain?: string
+}
 ```
 
 ## redeemSessionToken
@@ -725,7 +725,7 @@ type RedeemSessionTokenProps = {
    * @example "omni.example.com"
    * @example "omni.another-example.app"
    */
-  host?: string;
+  host?: string
 
   /**
    * Name of the organization the content belongs to. If provided, generates a default embed host
@@ -733,23 +733,23 @@ type RedeemSessionTokenProps = {
    *
    * @throws Error if `host` is provided.
    */
-  organizationName?: string;
+  organizationName?: string
 
   // Port of host.
-  port?: number;
+  port?: number
 
   // Optional dark mode setting. Can be one of "true", "false", or "system".
-  prefersDark?: string;
+  prefersDark?: string
 
   // Signing secret available to Omni admins.
-  secret: string;
+  secret: string
 
   // Session token string. The `createSessionToken` sdk function returns a session token that
   // can be used as the `sessionToken` parameter here in `redeemSessionToken`.
-  sessionToken: string;
+  sessionToken: string
 
   // Optional theme setting. Can be one of "dawn", "vibes", "breeze" or "blank".
-  theme?: string;
+  theme?: string
 
   // DEPRECATED
 
@@ -759,6 +759,6 @@ type RedeemSessionTokenProps = {
    *
    * @throws Error if `host` is provided.
    */
-  domain?: string;
-};
+  domain?: string
+}
 ```