@staffbase/widget-sdk 3.7.3 → 3.8.0

package/docs/SBImageEntity.md

@@ -1,74 +0,0 @@
-# Interface: SBImageEntity
-
-Image entity definition
-
-## Table of contents
-
-### Properties
-
-- [format](../wiki/SBImageEntity#format)
-- [height](../wiki/SBImageEntity#height)
-- [mimeType](../wiki/SBImageEntity#mimetype)
-- [size](../wiki/SBImageEntity#size)
-- [url](../wiki/SBImageEntity#url)
-- [width](../wiki/SBImageEntity#width)
-
-## Properties
-
-### format
-
-• `Optional` **format**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:117](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L117)
-
-___
-
-### height
-
-• **height**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:118](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L118)
-
-___
-
-### mimeType
-
-• `Optional` **mimeType**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:119](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L119)
-
-___
-
-### size
-
-• `Optional` **size**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:120](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L120)
-
-___
-
-### url
-
-• **url**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:121](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L121)
-
-___
-
-### width
-
-• **width**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:122](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L122)

package/docs/SBUserAvatar.md

@@ -1,52 +0,0 @@
-# Interface: SBUserAvatar
-
-User avatar definition
-
-## Table of contents
-
-### Properties
-
-- [icon](../wiki/SBUserAvatar#icon)
-- [original](../wiki/SBUserAvatar#original)
-- [publicID](../wiki/SBUserAvatar#publicid)
-- [thumb](../wiki/SBUserAvatar#thumb)
-
-## Properties
-
-### icon
-
-• **icon**: [`SBImageEntity`](../wiki/SBImageEntity)
-
-#### Defined in
-
-[lib/widget-api-types.ts:129](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L129)
-
-___
-
-### original
-
-• **original**: [`SBImageEntity`](../wiki/SBImageEntity)
-
-#### Defined in
-
-[lib/widget-api-types.ts:130](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L130)
-
-___
-
-### publicID
-
-• **publicID**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:131](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L131)
-
-___
-
-### thumb
-
-• **thumb**: [`SBImageEntity`](../wiki/SBImageEntity)
-
-#### Defined in
-
-[lib/widget-api-types.ts:132](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L132)

package/docs/SBUserProfile.md

@@ -1,96 +0,0 @@
-# Interface: SBUserProfile
-
-User profile data
-
-## Table of contents
-
-### Properties
-
-- [avatar](../wiki/SBUserProfile#avatar)
-- [department](../wiki/SBUserProfile#department)
-- [firstName](../wiki/SBUserProfile#firstname)
-- [lastName](../wiki/SBUserProfile#lastname)
-- [location](../wiki/SBUserProfile#location)
-- [phoneNumber](../wiki/SBUserProfile#phonenumber)
-- [position](../wiki/SBUserProfile#position)
-- [publicEmailAddress](../wiki/SBUserProfile#publicemailaddress)
-
-## Properties
-
-### avatar
-
-• `Optional` **avatar**: [`SBUserAvatar`](../wiki/SBUserAvatar)
-
-#### Defined in
-
-[lib/widget-api-types.ts:145](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L145)
-
-___
-
-### department
-
-• `Optional` **department**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:146](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L146)
-
-___
-
-### firstName
-
-• **firstName**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:139](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L139)
-
-___
-
-### lastName
-
-• **lastName**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:140](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L140)
-
-___
-
-### location
-
-• `Optional` **location**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:143](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L143)
-
-___
-
-### phoneNumber
-
-• `Optional` **phoneNumber**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:141](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L141)
-
-___
-
-### position
-
-• `Optional` **position**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:144](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L144)
-
-___
-
-### publicEmailAddress
-
-• `Optional` **publicEmailAddress**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:142](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L142)

package/docs/UserListItem.md

@@ -1,52 +0,0 @@
-# Interface: UserListItem
-
-Single user item
-
-## Table of contents
-
-### Properties
-
-- [entityType](../wiki/UserListItem#entitytype)
-- [firstName](../wiki/UserListItem#firstname)
-- [id](../wiki/UserListItem#id)
-- [lastName](../wiki/UserListItem#lastname)
-
-## Properties
-
-### entityType
-
-• `Optional` **entityType**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:175](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L175)
-
-___
-
-### firstName
-
-• `Optional` **firstName**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:173](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L173)
-
-___
-
-### id
-
-• `Optional` **id**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:172](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L172)
-
-___
-
-### lastName
-
-• `Optional` **lastName**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:174](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L174)

package/docs/UserListRequestQuery.md

@@ -1,52 +0,0 @@
-# Interface: UserListRequestQuery
-
-User list request parameters
-
-## Table of contents
-
-### Properties
-
-- [filter](../wiki/UserListRequestQuery#filter)
-- [limit](../wiki/UserListRequestQuery#limit)
-- [offset](../wiki/UserListRequestQuery#offset)
-- [sort](../wiki/UserListRequestQuery#sort)
-
-## Properties
-
-### filter
-
-• `Optional` **filter**: `string`
-
-#### Defined in
-
-[lib/widget-api-types.ts:165](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L165)
-
-___
-
-### limit
-
-• `Optional` **limit**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:162](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L162)
-
-___
-
-### offset
-
-• `Optional` **offset**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:163](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L163)
-
-___
-
-### sort
-
-• `Optional` **sort**: [`UserListSorting`](../wiki/Home#userlistsorting)
-
-#### Defined in
-
-[lib/widget-api-types.ts:164](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L164)

package/docs/UserListResponse.md

@@ -1,52 +0,0 @@
-# Interface: UserListResponse
-
-Responded user list
-
-## Table of contents
-
-### Properties
-
-- [data](../wiki/UserListResponse#data)
-- [limit](../wiki/UserListResponse#limit)
-- [offset](../wiki/UserListResponse#offset)
-- [total](../wiki/UserListResponse#total)
-
-## Properties
-
-### data
-
-• **data**: [`UserListItem`](../wiki/UserListItem)[]
-
-#### Defined in
-
-[lib/widget-api-types.ts:182](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L182)
-
-___
-
-### limit
-
-• **limit**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:184](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L184)
-
-___
-
-### offset
-
-• **offset**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:183](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L183)
-
-___
-
-### total
-
-• **total**: `number`
-
-#### Defined in
-
-[lib/widget-api-types.ts:185](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api-types.ts#L185)

package/docs/WidgetApi.md

@@ -1,138 +0,0 @@
-# Interface: WidgetApi
-
-Widget API class.
-
-A class providing access to additional information about the Staffbase ecosystem for widgets.
-
-## Table of contents
-
-### Methods
-
-- [getIntegration](../wiki/WidgetApi#getintegration)
-- [getLegacyAppTheme](../wiki/WidgetApi#getlegacyapptheme)
-- [getUserInformation](../wiki/WidgetApi#getuserinformation)
-- [getUserInformationByExternalId](../wiki/WidgetApi#getuserinformationbyexternalid)
-- [getUserList](../wiki/WidgetApi#getuserlist)
-
-## Methods
-
-### getIntegration
-
-▸ **getIntegration**(`type`): `Promise`<[`IntegrationInformation`](../wiki/IntegrationInformation)\>
-
-Call to retrieve a valid token to access the Microsoft API. Includes a time value to
-refresh the token.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `type` | ``"ms365"`` | The name of the integration. ("ms365") |
-
-#### Returns
-
-`Promise`<[`IntegrationInformation`](../wiki/IntegrationInformation)\>
-
-A promise containing the IntegrationInformation is returned. If the user session is
-not existing, the status is set to 'loggedOut' and the token is null. Additionally if the
-integration is not configured the status returns 'unavailable'.
-
-In case of an error, the promise is rejected.
-
-#### Defined in
-
-[lib/widget-api.ts:70](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L70)
-
-___
-
-### getLegacyAppTheme
-
-▸ **getLegacyAppTheme**(): [`ColorTheme`](../wiki/ColorTheme)
-
-Call to retrieve the color theme of the app. Since this theme definitions
-are currently redesigned, this method is called legacy.
-
-#### Returns
-
-[`ColorTheme`](../wiki/ColorTheme)
-
-An object containing the color theme data is returned.
-
-#### Defined in
-
-[lib/widget-api.ts:29](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L29)
-
-___
-
-### getUserInformation
-
-▸ **getUserInformation**(`userId?`): `Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
-
-Call to retrieve the user profile of the current or a specific user.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId?` | `string` | User ID to lookup for; leave blank to retrieve current user |
-
-#### Returns
-
-`Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
-
-A promise containing the SBUserProfile is returned. In case of an error,
-the promise is rejected.
-
-#### Defined in
-
-[lib/widget-api.ts:38](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L38)
-
-___
-
-### getUserInformationByExternalId
-
-▸ **getUserInformationByExternalId**(`externalId`): `Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
-
-Call to retrieve a user profile by its external ID.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `externalId` | `string` | An external ID of the user that shall be returned |
-
-#### Returns
-
-`Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
-
-A promise containing the SBUserProfile is returned. In case of an error,
-the promise is rejected.
-
-#### Defined in
-
-[lib/widget-api.ts:47](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L47)
-
-___
-
-### getUserList
-
-▸ **getUserList**(`query`): `Promise`<[`UserListResponse`](../wiki/UserListResponse)\>
-
-Call to retrieve a list of users determined by the query object.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `query` | [`UserListRequestQuery`](../wiki/UserListRequestQuery) | Adjust limit, offset, filter, and sorting for the request |
-
-#### Returns
-
-`Promise`<[`UserListResponse`](../wiki/UserListResponse)\>
-
-A promise containing the UserListResponse is returned. In case of an error,
-the promise is rejected.
-
-#### Defined in
-
-[lib/widget-api.ts:56](https://github.com/Staffbase/widget-sdk/blob/master/lib/widget-api.ts#L56)

package/docs/_Sidebar.md

@@ -1,3 +0,0 @@
-## @staffbase/widget-sdk
-
-- [Home](../wiki/Home)