@livechat/customer-sdk 3.1.4 → 4.0.0

package/README.md

@@ -63,27 +63,27 @@ Or use the node-style `require` call:
 
 ### Using a script tag - UMD module hosted on unpkg's CDN
 
-`<script src="https://unpkg.com/@livechat/customer-sdk@3.1.4"></script>`
+`<script src="https://unpkg.com/@livechat/customer-sdk@3.1.1"></script>`
 
 If you just want to look around and play with the SDK, check out our
 [sample chat widget implementation](https://codesandbox.io/s/rm3prxw88n).
 
 For the time being you need to register your application in the <a href="https://developers.livechat.com/console" target="_blank">Developers Console</a>
-as a "Web app (frontend, eg. JavaScript)" type. Then, you have to pass the configured `redirectUri` to the `init`, along with the regular required properties (`licenseId` and `clientId`).
+as a "Web app (frontend, eg. JavaScript)" type. Then, you have to pass the configured `redirectUri` to the `init`, along with the regular required properties (`organizationId` and `clientId`).
 
 ## Using the API
 
 To use the API you will first need to create an instance using the `init` function.
-You will need to provide your licenseId and clientId when creating a Customer SDK instance.
+You will need to provide your organizationId and clientId when creating a Customer SDK instance.
 
 Other optional configuration parameters are also available:
 
 | parameters           | type               | default | description                                                                                                                                                                                                                                                         |
 | -------------------- | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| licenseId            | number             |         | Your license number, you receive this value when creating a new livechat account.                                                                                                                                                                                   |
+| organizationId       | string             |         | Your Organization ID, you receive this value when creating a new livechat account.                                                                                                                                                                                  |
 | clientId             | string             |         | Your client id, you receive this value when you register your application in the LiveChat Developer Console.                                                                                                                                                        |
 | autoConnect          | boolean            | true    | Optional; should the library try to reconnect on it's own.                                                                                                                                                                                                          |
-| groupId              | number             |         | Optional; the id of the group you wish to connect to.                                                                                                                                                                                                               |
+| groupId              | number             | 0       | Optional; the id of the group you wish to connect to.                                                                                                                                                                                                               |
 | uniqueGroups         | boolean            | false   | Optional; by default, the customer's identity is the same for all groups. If you want to create a separate customer identity for each group, set this parameter to `true`. When set to `true`, passing a `groupId` is required.                                     |
 | region               | 'dal' \| 'fra'     | 'dal'   | Optional; the server region your license is at.                                                                                                                                                                                                                     |
 | redirectUri          | string             |         | Optional; should only be used inside ReactNative, this is the URI which your webview is redirected to after authorization.                                                                                                                                          |
@@ -111,7 +111,7 @@ The `init` function will return a Customer SDK instance:
 
 ```js
 const customerSDK = CustomerSDK.init({
-  licenseId: LICENSE_ID,
+  organizationId: ORGANIZATION_ID,
   clientId: CLIENT_ID,
 })
 ```
@@ -163,7 +163,7 @@ export default class App extends React.Component {
 
   componentDidMount() {
     this.customerSDK = init({
-      licenseId: LICENSE_ID,
+      organizationId: ORGANIZATION_ID,
       clientId: CLIENT_ID,
       redirectUri: REDIRECT_URI,
     })
@@ -1003,7 +1003,7 @@ Parameters:
 ### Errors
 
 - `CHAT_ALREADY_ACTIVE` - the chat is already active and you can't activate it again.
-- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen for licenses without continuous chats enabled.
+- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen when asynchronous communication is disabled.
 
 ## sendEvent
 
@@ -1071,73 +1071,6 @@ Parameters:
 | postback.id      | string  |         | Postback button ID |
 | postback.toggled | boolean | true    | Postback toggled   |
 
-## sendTicketForm
-
-Can be used to send a filled ticket form.
-
-```js
-customerSDK
-  .sendTicketForm({
-    groupId: 10,
-    filledForm: {
-      type: 'filled_form',
-      formId: '',
-      fields: [
-        {
-          type: 'subject',
-          id: '0',
-          label: 'Subject:',
-          answer: 'Order number 123',
-        },
-        {
-          type: 'email',
-          id: '1',
-          label: 'Your email:',
-          answer: 'john.doe@example.com',
-        },
-        {
-          type: 'checkbox',
-          id: '2',
-          label: 'Question:',
-          answers: [
-            { id: '0', label: 'First answer' },
-            { id: '1', label: 'Second answer' },
-          ],
-        },
-        {
-          type: 'textarea',
-          id: '3',
-          label: 'Your message:',
-          answer:
-            'Could I get a status update on this order? Have you already shipped it?',
-        },
-      ],
-    },
-  })
-  .then(response => {
-    console.log(`Created a ticket with id: ${response.id}`)
-  })
-  .catch(error => {
-    console.log(error)
-  })
-```
-
-Parameters:
-
-| parameters        | type              | description                    |
-| ----------------- | ----------------- | ------------------------------ |
-| filledForm.type   | 'filled_form'     |                                |
-| filledForm.formId | string            |                                |
-| filledForm.fields | FilledFormField[] |                                |
-| groupId           | number            | Optional                       |
-| timeZone          | string            | Optional, valid IANA Time Zone |
-
-Returned value:
-
-| properties | type   | description              |
-| ---------- | ------ | ------------------------ |
-| id         | string | ID of the created ticket |
-
 ## setCustomerSessionFields
 
 Sends the request to set customer's session fields. They are available for the duration of the session.
@@ -1212,7 +1145,7 @@ Parameters:
 ### Errors
 
 - `CHAT_LIMIT_REACHED` - the maximum limit of chats per Customer has been reached, and it's not possible to start a new one. You should activate one of the existing chats. The limit is 1.
-- `GROUPS_OFFLINE` - a group in the target chat is offline. It can happen for licenses, which don't allow Customers to chat during their unavailability.
+- `GROUPS_OFFLINE` - a group in the targeted chat is offline. It can happen when asynchronous communication is disabled.
 
 ## updateChatProperties
 
@@ -2085,11 +2018,11 @@ Internal error. Customer SDK reconnects on its own.
 
 ## License expired
 
-The license with the specified ID has expired. You should make sure that there are no unpaid invoices for it.
+The subscription for LiveChat product associated with the specified ID has expired. You should make sure that there are no unpaid invoices for it.
 
 ## License not found
 
-The license with the specified ID doesn't exist. You should check the options passed in to Customer SDK and make sure that the license parameter is correct.
+The LiveChat product associated with the specified ID doesn't exist. You should check the options passed in to Customer SDK and make sure that the parameters provided are correct.
 
 This internally destroys the current instance of Customer SDK, so it won't be possible to reuse it.
 
@@ -2197,6 +2130,22 @@ customerSDK.on('disconnected', ({ reason }) => {
 
 # Changelog
 
+## [v4.0.0] - 2023-09-19
+
+### Added
+
+- Additional types and constants for better development experience.
+
+### Changed
+
+Switched to using Customer API 3.5:
+
+- Drop support for the `licenseId` parameter in the `init` method. It has been replaced by the `organizationId`.
+
+### Removed
+
+- `sendTicketForm` method. As of June 1 2023 LiveChat tickets are handled by [HelpDesk](https://www.helpdesk.com/help/tickets-dashboard-guide/)
+
 ## [v3.1.2] - 2023-02-28
 
 ### Fixed