@wazo/sdk 0.42.0 → 0.43.0

package/README.md

@@ -30,10 +30,11 @@ Wazo's Javascript SDK allows you to use these features :
     + [Authentication with the simple API](#authentication-with-the-simple-api)
       - [Initializing](#initializing)
       - [Setting the engine host](#setting-the-engine-host)
-      - [Authenticating an user](#authenticating-an-user)
+      - [Authenticating a user](#authenticating-a-user)
+      - [Authenticating a user with SAML](#authenticating-a-user-with-SAML)
       - [Validating a token](#validating-a-token)
       - [Setting a callback when a new token is refreshed](#setting-a-callback-when-a-new-token-is-refreshed)
-      - [Loggin out](#loggin-out)
+      - [Logging out](#logging-out)
     + [Conference](#conference)
       - [Joining a room](#joining-a-room)
       - [Sending a chat message in the room](#sending-a-chat-message-in-the-room)
@@ -51,7 +52,7 @@ Wazo's Javascript SDK allows you to use these features :
       - [Merging sessions in one conference](#merging-sessions-in-one-conference)
       - [Add a session to a conference](#add-a-call-to-a-conference)
       - [Remove a session from a conference](#remove-a-call-from-a-conference)
-      - [Unmerge a sessions from a conference](#terminating-a-conference)
+      - [Terminating a conference](#terminating-a-conference)
     + [Accessing the current WebRtc phone](#accessing-the-current-webrtc-phone)
     + [Domains](#domains)
       - [Participant](#participant)
@@ -87,7 +88,7 @@ Wazo's Javascript SDK allows you to use these features :
       - [WebRTCClient Configuration](#webrtcclient-configuration)
       - [Basic client features](#basic-client-features)
         - [Calling a number](#calling-a-number)
-        - [Be notified to a phone call](#be-notified-to-a-phone-call)
+        - [Be notified of a phone call](#be-notified-of-a-phone-call)
         - [Answering a call](#answering-a-call)
         - [Hangup a call](#hangup-a-call)
         - [Rejecting a call](#rejecting-a-call)
@@ -138,7 +139,7 @@ Wazo's Javascript SDK allows you to use these features :
         - [Sending a SIP message](#sending-a-sip-message)
         - [Closing the phone](#closing-the-phone)
         - [Starting heartbeat](#starting-heartbeat)
-        - [Stopping heatbeat](#stopping-heatbeat)
+        - [Stopping heartbeat](#stopping-heartbeat)
     + [WebSocketClient](#wazo-websocket)
       - [Web Socket features](#web-socket-features)
         - [Opening the socket](#opening-the-socket)
@@ -223,7 +224,7 @@ Wazo.Auth.fetchOptions({
 - `options`: Object
   - Options passed to all the `fetch` requests of the SDK.
 
-### Authenticating an user
+#### Authenticating a user
 ```js
 const session = await Wazo.Auth.logIn(username, password, backend, tenantId);
 ```
@@ -244,6 +245,16 @@ Returns as `Wazo.domain.Session`. This object contains, among other information,
 
 Note: you need to set `clientId` in your WazoAPIClient in order to get a refresh token in the returned `Session`.
 
+#### Authenticating a user with SAML
+```js
+const session = await Wazo.Auth.samlLogIn(samlSessionId);
+```
+
+- `samlSessionId`: string
+  - samlSessionId generated by wazo-auth
+
+Returns as `Wazo.domain.Session`. This object contains, among other information, the user's token.
+
 #### Validating a token
 
 ```js
@@ -272,7 +283,7 @@ Wazo.Auth.setOnRefreshToken(token => { /* Do something with the new token */ });
 - `callback`: Function(token: string)
   - A function that is triggered when the user's token will soon expire.
 
-#### Loggin out
+#### Logging out
 
 Destroys user's token and refreshToken.
 
@@ -427,11 +438,11 @@ Triggered when screensharing is stopped.
 room.on(room.ON_TALKING, (channel, participant) => {});
 ```
 
-Triggered when a participant is talking, or stops talking.
+Triggered when a participant is talking or stops talking.
 
 - `channel`: Object containing information about the event.
 - `participant`: `Wazo.RemoteParticipant` or `Wazo.LocalParticipant`.
-  The participant instance, your can access the `participant.isTalking` attribute to know the status.
+  The participant instance, you can access the `participant.isTalking` attribute to know the status.
   
 ### Ad hoc Conference features
 **`Voice`**   **`Video`** 
@@ -456,7 +467,7 @@ adHocConference.removeParticipant(callSession: CallSession);
 ```
 
 #### Terminating a conference
-Use this method to remove a single participant from a conference.
+Use this method to terminate a conference.
 ```js
 adHocConference.hangup();
 ```
@@ -579,11 +590,11 @@ Triggered when the participant is sharing his screen.
 participant.on(participant.ON_STOP_SCREENSHARING, () => {});
 ```
 
-Triggered when the participant stop sharing his screen. 
+Triggered when the participant stops sharing his screen. 
 
 #### Stream
 
-`Wazo.Stream` helps attaching or detaching streams to html elements:
+`Wazo.Stream` helps attach or detach streams to HTML elements:
 
 `stream.attach(htmlEmelent)`
 
@@ -704,7 +715,7 @@ client.setOnRefreshToken((newToken, newSession) => {
 });
 ```
 
-Note: you need to set `clientId` in your WazoAPIClient in order to refresh token.
+Note: you need to set `clientId` in your WazoAPIClient to refresh a token.
 
 #### Log Out
 **`Voice`**   **`Video`**  **`Chat`**   **`Fax`**  **`Status`**  **`Config`**   **`Misc`**
@@ -741,7 +752,7 @@ client.auth.createPolicy(name, description, acl);
 client.auth.listPolicies();
 ```
 
-### Sending logs to fluentd via a http endpoint
+### Sending logs to fluentd via a HTTP endpoint
 
 #### Logger
 **`Log`**
@@ -793,7 +804,7 @@ client.application.playCall(applicationUuid, callId, language, uri); // play a s
 **`Voice`**   **`Video`**  **`Chat`**   **`Fax`**  **`Status`**
 
 Use Calld to directly control interactions.
-(Please note, ctidNg endpoint is deprecated but continue to work with old version. **Please update your code**.)
+(Please note, ctidNg endpoint is deprecated but continues to work with old versions. **Please update your code**.)
 
 ```js
 client.calld.getConferenceParticipantsAsUser(conferenceId); // List participants of a conference the user is part of
@@ -996,7 +1007,7 @@ Use this method to dial a number.
 client.call(number: string);
 ```
 
-##### Be notified to a phone call
+##### Be notified of a phone call
 Use this method to be notified of an incoming call.
 ```js
 client.on('invite', (sipSession: SipSession) => {
@@ -1390,14 +1401,14 @@ See webrtcClient's `heartbeatDelay`, `heartbeatTimeout`, `maxHeartbeats`, [confi
 phone.startHeartbeat();
 ```
 
-##### Stopping heatbeat
+##### Stopping heartbeat
 
 ```js
 phone.stopHeartbeat();
 ```
 
 ### Wazo WebSocket
-You can use the Wazo WebSocket to listen for real time events (eg: receiving a chat message, a presential update ...)
+You can use the Wazo WebSocket to listen for real-time events (eg: receiving a chat message, a presential update...)
 
 #### Web Socket features
 **`Voice`**   **`Video`**  **`Chat`**   **`Fax`**  **`Status`**
@@ -1451,15 +1462,15 @@ ws.close();
 ```
 
 
-# Usage with webpack 5
+# Usage with Webpack 5
 
-As webpack 5 dropped some polyfill, you have to add them:
+As Webpack 5 dropped some polyfills, you have to add them manually:
 
 ```sh
 yarn add -D assert buffer https-browserify url stream-http stream-browserify browserify-zlib process
 ```
 
-If you have used `create-react-app` to create your app, you can customize the webpack configuration with `react-app-rewired` :
+If you have used `create-react-app` to create your app, you can customize the Webpack configuration with `react-app-rewired` :
 
 ```sh
 yarn add -D react-app-rewired