Skip to content

Commit

Permalink
Update package-lock.json
Browse files Browse the repository at this point in the history
  • Loading branch information
dukhovnyi committed Dec 12, 2024
1 parent d5bd96d commit bd2dd38
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/npm-publish-github-packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ jobs:

# Publishing packages
- run: npm pkg set version='${{ github.event.inputs.version }}'
- run: npm publish --tag stable
- run: npm publish --tag stable
79 changes: 49 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,22 @@ GliaSdk.startAudio();

<docgen-index>

- [`configure(...)`](#configure)
- [`startChat(...)`](#startchat)
- [`startAudio(...)`](#startaudio)
- [`startVideo(...)`](#startvideo)
- [`startSecureConversation(...)`](#startsecureconversation)
- [`clearVisitorSession()`](#clearvisitorsession)
- [`listQueues()`](#listqueues)
- [`showVisitorCodeViewController()`](#showvisitorcodeviewcontroller)
- [`authenticate(...)`](#authenticate)
- [`deauthenticate()`](#deauthenticate)
- [`isAuthenticated()`](#isauthenticated)
- [`refreshAuthentication(...)`](#refreshauthentication)
- [`pauseLiveObservation()`](#pauseliveobservation)
- [`resumeLiveObservation()`](#resumeliveobservation)
- [Interfaces](#interfaces)
- [Type Aliases](#type-aliases)
* [`configure(...)`](#configure)
* [`startChat(...)`](#startchat)
* [`startAudio(...)`](#startaudio)
* [`startVideo(...)`](#startvideo)
* [`startSecureConversation(...)`](#startsecureconversation)
* [`clearVisitorSession()`](#clearvisitorsession)
* [`listQueues()`](#listqueues)
* [`showVisitorCodeViewController()`](#showvisitorcodeviewcontroller)
* [`authenticate(...)`](#authenticate)
* [`deauthenticate()`](#deauthenticate)
* [`isAuthenticated()`](#isauthenticated)
* [`refreshAuthentication(...)`](#refreshauthentication)
* [`pauseLiveObservation()`](#pauseliveobservation)
* [`resumeLiveObservation()`](#resumeliveobservation)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

</docgen-index>

Expand All @@ -68,7 +68,8 @@ NB! To make plugin work properly, use `create-visitor` credentials for Site APIK
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code>{ siteId: string; apiKey: <a href="#apikey">ApiKey</a>; region: <a href="#region">Region</a>; companyName: string; overrideLocale?: string; }</code> |

---
--------------------


### startChat(...)

Expand All @@ -82,7 +83,8 @@ Starts a new chat/text engagement with queue identifiers. If `queueIds` is null
| ------------- | ------------------------------------- |
| **`options`** | <code>{ queueIds?: string[]; }</code> |

---
--------------------


### startAudio(...)

Expand All @@ -96,7 +98,8 @@ Starts a new audio engagement with queue identifiers. If `queueIds` is null or e
| ------------- | ------------------------------------- |
| **`options`** | <code>{ queueIds?: string[]; }</code> |

---
--------------------


### startVideo(...)

Expand All @@ -110,7 +113,8 @@ Starts a new video engagement for queue identifiers. If `queueIds` is null or em
| ------------- | ------------------------------------- |
| **`options`** | <code>{ queueIds?: string[]; }</code> |

---
--------------------


### startSecureConversation(...)

Expand All @@ -125,7 +129,8 @@ Secure Conversation requires authentication/IdToken.
| ------------- | --------------------------------------------------------------------------------------------------------- |
| **`options`** | <code>{ startScreen: <a href="#secureconversationstartscreen">SecureConversationStartScreen</a>; }</code> |

---
--------------------


### clearVisitorSession()

Expand All @@ -135,7 +140,8 @@ clearVisitorSession() => Promise<void>

Recreates currently used visitor in SDK.

---
--------------------


### listQueues()

Expand All @@ -147,7 +153,8 @@ Fetches all queues with its info for current site.

**Returns:** <code>Promise&lt;any&gt;</code>

---
--------------------


### showVisitorCodeViewController()

Expand All @@ -157,7 +164,8 @@ showVisitorCodeViewController() => Promise<void>

Presents GliaWidgets UI with visitor code for sharing with operator to start an engagement.

---
--------------------


### authenticate(...)

Expand All @@ -171,7 +179,8 @@ Authenticates visitor.
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| **`options`** | <code>{ behavior: <a href="#authenticationbehavior">AuthenticationBehavior</a>; idToken: string; accessToken?: string; }</code> | - Provides options for authentication such as behavior, idToken, and accessToken. |

---
--------------------


### deauthenticate()

Expand All @@ -181,7 +190,8 @@ deauthenticate() => Promise<void>

Deauthenticates visitor. Be aware that deauthentication process relies on <a href="#authenticationbehavior">`AuthenticationBehavior`</a>

---
--------------------


### isAuthenticated()

Expand All @@ -191,7 +201,8 @@ isAuthenticated() => Promise<void>

Provides current authentication state

---
--------------------


### refreshAuthentication(...)

Expand All @@ -205,7 +216,8 @@ Refreshes authentication access properties.
| ------------- | ------------------------------------------------------- |
| **`options`** | <code>{ idToken: string; accessToken?: string; }</code> |

---
--------------------


### pauseLiveObservation()

Expand All @@ -215,7 +227,8 @@ pauseLiveObservation() => Promise<void>

Makes a pause for ongoing LiveObservation session.

---
--------------------


### resumeLiveObservation()

Expand All @@ -225,31 +238,37 @@ resumeLiveObservation() => Promise<void>

Resumes ongoing LiveObservation session.

---
--------------------


### Interfaces


#### ApiKey

| Prop | Type |
| ------------ | ------------------- |
| **`id`** | <code>string</code> |
| **`secret`** | <code>string</code> |


### Type Aliases


#### Region

Site's region.

<code>'us' | 'eu' | 'beta'</code>


#### SecureConversationStartScreen

Start screen for Secure Conversation flow.

<code>'welcome' | 'chatTranscript'</code>


#### AuthenticationBehavior

Authentication (IdToken) behavior.
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bd2dd38

Please sign in to comment.