@wazo/sdk 0.38.2 → 0.38.5

package/README.md

@@ -615,6 +615,8 @@ Wazo.Softphone.init({
   wrapUpDuration, // How long (in seconds) should the softphone display the card after the call (optional).
   // When the user changes anything on the card, this timeout is canceled
   enableAgent, // display the agent tab in the tab bar (defaults to true).
+  tenantId, // Tenant id used for LDAP connection
+  debug, // Set to `true` to display wording customization labels
 });
 ```
 
@@ -653,10 +655,14 @@ Wazo.Softphone.setCardValue(field, value);
 ```
 
 #### Customizing page style
+
+You can inspect the iframe with your dev tool console to figure out how to override styles.
+
 ```js
 Wazo.Softphone.injectCss(`
-  body {
-    background-color: #eee;
+  # Reduce dialer number font size
+  .keypad-number, .keypad-number::placeholder {
+    font-size: 20px;
   }
 `);
 ```
@@ -664,11 +670,36 @@ Wazo.Softphone.injectCss(`
 #### Override appearance
 ```js
 Softphone.customizeAppearance({
-  // Theme
+  // Theme, default values :
+  primary: '#203890',
+  button: '#292C87',
+  black: '#000',
+  white: '#fff',
+  greenButton: '#7ed865',
+  greenButtonHover: '#6ebf5a',
+  redButton: '#FA5846',
+  redButtonHover: '#FF604F',
+  buttonText: '#fff',
+  error: '#E80539',
+  secondary: '#203890',
+  grey: '#8A95A0',
+  secondGrey: '#eee',
+  headerColor: '#888',
+  avatar: '#bdbdbd',
+  divider: 'rgba(0, 0, 0, 0.12)',
+  placeholder: 'rgba(22, 44, 66, 0.5)',
+  hovered: '#6181F4',
 }, {
   // Translation
+  // Set `debug: true` to know where to change translations, eg:
+  en: {
+    user: {
+      login: 'My login button', // will be displayed as `user:login` in the button when settings `debug: true` in the init() method
+    },
+  },
 }, {
   // Assets
+  // logo: [url to your logo],
 });
 ```
 
@@ -742,6 +773,22 @@ Softphone.onCallIncoming = call => {
   // You can make action here like redirecting to the contact page (by using `call.number).
 };
 
+Softphone.onCallLocallyAnswered = call => {
+  // Invoked when the user accepts the call locally
+};
+
+Softphone.onCallEstablished = call => {
+  // Invoked when the call is up
+};
+
+Softphone.onOutgoingCallMade = call => {
+  // Invoked when the user makes a call
+};
+
+Softphone.onCallRejected = call => {
+  // Invoked when the user rejects an incoming call
+};
+
 Softphone.onCallEnded = (call, card, direction) => {
   // Invoked when the call is ended
 };
@@ -750,10 +797,6 @@ Softphone.onCardSaved = card => {
   // Invoked when the user save the card at the end of the call
 };
 
-Softphone.onCallMade = call => {
-  // Invoked when an outgoing call is made
-};
-
 Softphone.onSearchOptions = (fieldId: string, query: string) => {
   // Invoked when the user is making a search from an Autocomplete field in the card form
   // We need to call `onOptionsResults` here to send results to the softphone
@@ -843,6 +886,10 @@ Softphone.onAuthenticated = session => {
 Softphone.onLoggedOut = session => {
   // Invoked when the user is is logged out in the softphone
 };
+
+Softphone.onIFrameLoaded = session => {
+  // Invoked when the iframe is loaded
+};
 ```
 
 ## Advanced API
@@ -881,7 +928,7 @@ import { WazoWebSocketClient } from '@wazo/sdk';
 
 ```js
 const client = new WazoApiClient({
-  server: 'stack.dev.wazo.io', // required string
+  server: 'stack.example.com', // required string
   agent: null, // http(s).Agent instance, allows custom proxy, unsecured https, certificate etc.
   clientId: null, // Set an identifier for your app when using refreshToken
   isMobile: false,
@@ -1149,7 +1196,7 @@ Use this generic method to request endpoints directly.
 
 ```js
 const requester = new ApiRequester({ 
-  server: 'stack.dev.wazo.io', // Engine server
+  server: 'stack.example.com', // Engine server
   refreshTokenCallback: () => {}, // Called when the token is refreshed
   clientId: 'my-id', // ClientId used for refreshToken
   agent: null, // http(s).Agent instance, allows custom proxy, unsecured https, certificate etc.
@@ -1171,7 +1218,7 @@ const session = await client.auth.logIn({ ... }); // log in
 
 const client = new WazoWebRTCClient({
   displayName: 'From WEB',
-  host: 'stack.dev.wazo.io',
+  host: 'stack.example.com',
   websocketSip: 'other.url.com', // Allows to connect throught another URL than host (default to `host` is not set).
   media: {
     audio: boolean,