@gofynd/fdk-client-javascript 0.1.35

package/documentation/application/LEAD.md

@@ -0,0 +1,1891 @@
+
+
+
+
+##### [Back to Application docs](./README.md)
+
+## Lead Methods
+Handles communication between Staff and Users
+* [getTicket](#getticket)
+* [createHistory](#createhistory)
+* [createTicket](#createticket)
+* [getCustomForm](#getcustomform)
+* [submitCustomForm](#submitcustomform)
+* [getParticipantsInsideVideoRoom](#getparticipantsinsidevideoroom)
+* [getTokenForVideoRoom](#gettokenforvideoroom)
+
+
+
+## Methods with example and description
+
+
+### getTicket
+Get Ticket with the specific id
+
+
+
+```javascript
+// Promise
+const promise = lead.getTicket({  id : value });
+
+// Async/Await
+const data = await lead.getTicket({  id : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| id | string | yes | ID of ticket to be retrieved |  
+
+
+
+Get Ticket with the specific id, this is used to view the ticket details
+
+*Returned Response:*
+
+
+
+
+[Ticket](#Ticket)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "context": {
+      "application_id": "000000000000000000000003",
+      "company_id": "884"
+    },
+    "content": {
+      "title": "SOme title Response",
+      "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
+      "attachments": []
+    },
+    "status": {
+      "display": "In Progress",
+      "color": "#ffa951",
+      "key": "in_progress"
+    },
+    "priority": {
+      "display": "Medium",
+      "color": "#f37736",
+      "key": "medium"
+    },
+    "assigned_to": {
+      "agent_id": "5d1363adf599d850df93175e",
+      "gender": "male",
+      "accountType": "user",
+      "active": true,
+      "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+      "hasOldPasswordHash": false,
+      "_id": "5d1363adf599d850df93175e",
+      "phoneNumbers": [
+        {
+          "active": true,
+          "primary": true,
+          "verified": true,
+          "countryCode": 91,
+          "phone": "9890425946"
+        }
+      ],
+      "firstName": "Nikhil",
+      "lastName": "Manapure",
+      "emails": [
+        {
+          "active": true,
+          "primary": true,
+          "verified": true,
+          "email": "nikhilmshchs@gmail.com"
+        }
+      ],
+      "username": "nikhilmshchs_gmail_com_38425_20500281",
+      "createdAt": "2019-01-01T17:22:38.528Z",
+      "updatedAt": "2021-01-22T10:02:42.258Z",
+      "uid": "20500281",
+      "__v": 56
+    },
+    "tags": [
+      "some-title"
+    ],
+    "_id": "6012f38557751ee8fc162cf7",
+    "created_on": {
+      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
+      "platform": "web",
+      "meta": {
+        "browser": {
+          "name": "Chrome",
+          "version": "88.0.4324.96"
+        },
+        "os": {
+          "name": "macOS",
+          "version": "10.15.7",
+          "versionName": "Catalina"
+        },
+        "platform": {
+          "type": "desktop",
+          "vendor": "Apple"
+        },
+        "engine": {
+          "name": "Blink"
+        }
+      }
+    },
+    "source": "sales_channel",
+    "created_by": {
+      "id": "5d1363adf599d850df93175e",
+      "user": {
+        "gender": "male",
+        "accountType": "user",
+        "active": true,
+        "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+        "hasOldPasswordHash": false,
+        "_id": "5d1363adf599d850df93175e",
+        "phoneNumbers": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "countryCode": 91,
+            "phone": "9890425946"
+          }
+        ],
+        "firstName": "Nikhil",
+        "lastName": "Manapure",
+        "emails": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "email": "nikhilmshchs@gmail.com"
+          }
+        ],
+        "username": "nikhilmshchs_gmail_com_38425_20500281",
+        "createdAt": "2019-01-01T17:22:38.528Z",
+        "updatedAt": "2021-01-22T10:02:42.258Z",
+        "uid": "20500281",
+        "__v": 56
+      }
+    },
+    "response_id": "6012f38457751e0fb8162cf6",
+    "category": {
+      "form": {
+        "login_required": false,
+        "should_notify": false,
+        "inputs": [
+          {
+            "required": false,
+            "type": "text",
+            "enum": [],
+            "display": "Single lineeee",
+            "key": "single-lineeee",
+            "showRegexInput": false
+          },
+          {
+            "required": false,
+            "type": "email",
+            "enum": [],
+            "display": "Email",
+            "regex": "\\S+@\\S+\\.\\S+",
+            "key": "email",
+            "showRegexInput": true
+          },
+          {
+            "required": false,
+            "type": "text",
+            "enum": [],
+            "display": "dfsdf",
+            "key": "dfsdf",
+            "showRegexInput": false
+          }
+        ],
+        "available_assignees": [
+          "5b9b98150df588546aaea6d2",
+          "5c45d78395d7504f76c2cb37"
+        ],
+        "_id": "5fd72db3dc250f8decfc61b2",
+        "title": "SOme title",
+        "description": "SOme big description",
+        "slug": "some-title",
+        "application_id": "000000000000000000000003",
+        "created_on": {
+          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
+          "platform": "web",
+          "meta": {
+            "browser": {
+              "name": "Chrome",
+              "version": "87.0.4280.88"
+            },
+            "os": {
+              "name": "macOS",
+              "version": "10.15.6",
+              "versionName": "Catalina"
+            },
+            "platform": {
+              "type": "desktop",
+              "vendor": "Apple"
+            },
+            "engine": {
+              "name": "Blink"
+            }
+          }
+        },
+        "created_by": "5d1363adf599d850df93175e",
+        "createdAt": "2020-12-14T09:17:39.953Z",
+        "updatedAt": "2021-01-28T18:48:07.717Z",
+        "__v": 0
+      },
+      "key": "some-title",
+      "display": "SOme title"
+    },
+    "ticket_id": "43",
+    "createdAt": "2021-01-28T17:25:25.013Z",
+    "updatedAt": "2021-01-28T17:25:33.396Z",
+    "__v": 0,
+    "video_room_id": "6012f38557751ee8fc162cf7"
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createHistory
+Create history for specific Ticket
+
+
+
+```javascript
+// Promise
+const promise = lead.createHistory({  id : value,
+ body : value });
+
+// Async/Await
+const data = await lead.createHistory({  id : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| id | string | yes | Ticket ID for which history is created |  
+| body | [TicketHistoryPayload](#TicketHistoryPayload) | yes | Request body |
+
+
+Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+
+*Returned Response:*
+
+
+
+
+[TicketHistory](#TicketHistory)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "_id": "601a9d52c26687d086c499ef",
+    "ticket_id": "41",
+    "type": "comment",
+    "value": {
+      "text": "d",
+      "media": []
+    },
+    "created_on": {
+      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
+      "platform": "web",
+      "meta": {
+        "browser": {
+          "name": "Chrome",
+          "version": "88.0.4324.96"
+        },
+        "os": {
+          "name": "macOS",
+          "version": "10.15.7",
+          "versionName": "Catalina"
+        },
+        "platform": {
+          "type": "desktop",
+          "vendor": "Apple"
+        },
+        "engine": {
+          "name": "Blink"
+        }
+      }
+    },
+    "created_by": "5d1363adf599d850df93175e",
+    "createdAt": "2021-02-03T12:55:46.808Z",
+    "updatedAt": "2021-02-03T12:55:46.808Z",
+    "__v": 0
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createTicket
+Create Ticket
+
+
+
+```javascript
+// Promise
+const promise = lead.createTicket({  body : value });
+
+// Async/Await
+const data = await lead.createTicket({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [AddTicketPayload](#AddTicketPayload) | yes | Request body |
+
+
+This is used to Create Ticket.
+
+*Returned Response:*
+
+
+
+
+[Ticket](#Ticket)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "context": {
+      "application_id": "000000000000000000000003",
+      "company_id": "884"
+    },
+    "content": {
+      "title": "SOme title Response",
+      "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
+      "attachments": []
+    },
+    "status": {
+      "display": "In Progress",
+      "color": "#ffa951",
+      "key": "in_progress"
+    },
+    "priority": {
+      "display": "Medium",
+      "color": "#f37736",
+      "key": "medium"
+    },
+    "assigned_to": {
+      "agent_id": "5d1363adf599d850df93175e",
+      "gender": "male",
+      "accountType": "user",
+      "active": true,
+      "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+      "hasOldPasswordHash": false,
+      "_id": "5d1363adf599d850df93175e",
+      "phoneNumbers": [
+        {
+          "active": true,
+          "primary": true,
+          "verified": true,
+          "countryCode": 91,
+          "phone": "9890425946"
+        }
+      ],
+      "firstName": "Nikhil",
+      "lastName": "Manapure",
+      "emails": [
+        {
+          "active": true,
+          "primary": true,
+          "verified": true,
+          "email": "nikhilmshchs@gmail.com"
+        }
+      ],
+      "username": "nikhilmshchs_gmail_com_38425_20500281",
+      "createdAt": "2019-01-01T17:22:38.528Z",
+      "updatedAt": "2021-01-22T10:02:42.258Z",
+      "uid": "20500281",
+      "__v": 56
+    },
+    "tags": [
+      "some-title"
+    ],
+    "_id": "6012f38557751ee8fc162cf7",
+    "created_on": {
+      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
+      "platform": "web",
+      "meta": {
+        "browser": {
+          "name": "Chrome",
+          "version": "88.0.4324.96"
+        },
+        "os": {
+          "name": "macOS",
+          "version": "10.15.7",
+          "versionName": "Catalina"
+        },
+        "platform": {
+          "type": "desktop",
+          "vendor": "Apple"
+        },
+        "engine": {
+          "name": "Blink"
+        }
+      }
+    },
+    "source": "sales_channel",
+    "created_by": {
+      "id": "5d1363adf599d850df93175e",
+      "user": {
+        "gender": "male",
+        "accountType": "user",
+        "active": true,
+        "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+        "hasOldPasswordHash": false,
+        "_id": "5d1363adf599d850df93175e",
+        "phoneNumbers": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "countryCode": 91,
+            "phone": "9890425946"
+          }
+        ],
+        "firstName": "Nikhil",
+        "lastName": "Manapure",
+        "emails": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "email": "nikhilmshchs@gmail.com"
+          }
+        ],
+        "username": "nikhilmshchs_gmail_com_38425_20500281",
+        "createdAt": "2019-01-01T17:22:38.528Z",
+        "updatedAt": "2021-01-22T10:02:42.258Z",
+        "uid": "20500281",
+        "__v": 56
+      }
+    },
+    "response_id": "6012f38457751e0fb8162cf6",
+    "category": {
+      "form": {
+        "login_required": false,
+        "should_notify": false,
+        "inputs": [
+          {
+            "required": false,
+            "type": "text",
+            "enum": [],
+            "display": "Single lineeee",
+            "key": "single-lineeee",
+            "showRegexInput": false
+          },
+          {
+            "required": false,
+            "type": "email",
+            "enum": [],
+            "display": "Email",
+            "regex": "\\S+@\\S+\\.\\S+",
+            "key": "email",
+            "showRegexInput": true
+          },
+          {
+            "required": false,
+            "type": "text",
+            "enum": [],
+            "display": "dfsdf",
+            "key": "dfsdf",
+            "showRegexInput": false
+          }
+        ],
+        "available_assignees": [
+          "5b9b98150df588546aaea6d2",
+          "5c45d78395d7504f76c2cb37"
+        ],
+        "_id": "5fd72db3dc250f8decfc61b2",
+        "title": "SOme title",
+        "description": "SOme big description",
+        "slug": "some-title",
+        "application_id": "000000000000000000000003",
+        "created_on": {
+          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
+          "platform": "web",
+          "meta": {
+            "browser": {
+              "name": "Chrome",
+              "version": "87.0.4280.88"
+            },
+            "os": {
+              "name": "macOS",
+              "version": "10.15.6",
+              "versionName": "Catalina"
+            },
+            "platform": {
+              "type": "desktop",
+              "vendor": "Apple"
+            },
+            "engine": {
+              "name": "Blink"
+            }
+          }
+        },
+        "created_by": "5d1363adf599d850df93175e",
+        "createdAt": "2020-12-14T09:17:39.953Z",
+        "updatedAt": "2021-01-28T18:48:07.717Z",
+        "__v": 0
+      },
+      "key": "some-title",
+      "display": "SOme title"
+    },
+    "ticket_id": "43",
+    "createdAt": "2021-01-28T17:25:25.013Z",
+    "updatedAt": "2021-01-28T17:25:33.396Z",
+    "__v": 0,
+    "video_room_id": "6012f38557751ee8fc162cf7"
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getCustomForm
+Get specific Custom Form using it's slug
+
+
+
+```javascript
+// Promise
+const promise = lead.getCustomForm({  slug : value });
+
+// Async/Await
+const data = await lead.getCustomForm({  slug : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| slug | string | yes | Slug of form whose response is getting submitted |  
+
+
+
+Get specific Custom Form using it's slug, this is used to view the form.
+
+*Returned Response:*
+
+
+
+
+[CustomForm](#CustomForm)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "login_required": false,
+    "should_notify": false,
+    "inputs": [
+      {
+        "required": false,
+        "type": "text",
+        "display": "Name",
+        "placeholder": "Please enter your name",
+        "key": "name"
+      }
+    ],
+    "available_assignees": [],
+    "_id": "5fd258a9088f957f34c288fc",
+    "title": "trail form",
+    "description": "Trail form description",
+    "slug": "trail-form",
+    "application_id": "000000000000000000000003",
+    "created_on": {
+      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
+      "platform": "web",
+      "meta": {
+        "browser": {
+          "name": "Chrome",
+          "version": "87.0.4280.88"
+        },
+        "os": {
+          "name": "macOS",
+          "version": "10.15.6",
+          "versionName": "Catalina"
+        },
+        "platform": {
+          "type": "desktop",
+          "vendor": "Apple"
+        },
+        "engine": {
+          "name": "Blink"
+        }
+      }
+    },
+    "created_by": "5d1363adf599d850df93175e",
+    "createdAt": "2020-12-10T17:19:37.515Z",
+    "updatedAt": "2020-12-10T17:19:43.214Z",
+    "__v": 0
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### submitCustomForm
+Submit Response for a specific Custom Form using it's slug
+
+
+
+```javascript
+// Promise
+const promise = lead.submitCustomForm({  slug : value,
+ body : value });
+
+// Async/Await
+const data = await lead.submitCustomForm({  slug : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| slug | string | yes | Slug of form whose response is getting submitted |  
+| body | [CustomFormSubmissionPayload](#CustomFormSubmissionPayload) | yes | Request body |
+
+
+Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+
+*Returned Response:*
+
+
+
+
+[SubmitCustomFormResponse](#SubmitCustomFormResponse)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "ticket": {
+      "context": {
+        "application_id": "000000000000000000000003",
+        "company_id": "884"
+      },
+      "content": {
+        "title": "SOme title Response",
+        "description": "<b>Single lineeee</b>: asdf<br><b>Email</b>: asdf@asdf.com<br><b>dfsdf</b>: asdf<br>",
+        "attachments": []
+      },
+      "status": {
+        "display": "In Progress",
+        "color": "#ffa951",
+        "key": "in_progress"
+      },
+      "priority": {
+        "display": "Medium",
+        "color": "#f37736",
+        "key": "medium"
+      },
+      "assigned_to": {
+        "agent_id": "5d1363adf599d850df93175e",
+        "gender": "male",
+        "accountType": "user",
+        "active": true,
+        "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+        "hasOldPasswordHash": false,
+        "_id": "5d1363adf599d850df93175e",
+        "phoneNumbers": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "countryCode": 91,
+            "phone": "9890425946"
+          }
+        ],
+        "firstName": "Nikhil",
+        "lastName": "Manapure",
+        "emails": [
+          {
+            "active": true,
+            "primary": true,
+            "verified": true,
+            "email": "nikhilmshchs@gmail.com"
+          }
+        ],
+        "username": "nikhilmshchs_gmail_com_38425_20500281",
+        "createdAt": "2019-01-01T17:22:38.528Z",
+        "updatedAt": "2021-01-22T10:02:42.258Z",
+        "uid": "20500281",
+        "__v": 56
+      },
+      "tags": [
+        "some-title"
+      ],
+      "_id": "6012f38557751ee8fc162cf7",
+      "created_on": {
+        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
+        "platform": "web",
+        "meta": {
+          "browser": {
+            "name": "Chrome",
+            "version": "88.0.4324.96"
+          },
+          "os": {
+            "name": "macOS",
+            "version": "10.15.7",
+            "versionName": "Catalina"
+          },
+          "platform": {
+            "type": "desktop",
+            "vendor": "Apple"
+          },
+          "engine": {
+            "name": "Blink"
+          }
+        }
+      },
+      "source": "sales_channel",
+      "created_by": {
+        "id": "5d1363adf599d850df93175e",
+        "user": {
+          "gender": "male",
+          "accountType": "user",
+          "active": true,
+          "profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
+          "hasOldPasswordHash": false,
+          "_id": "5d1363adf599d850df93175e",
+          "phoneNumbers": [
+            {
+              "active": true,
+              "primary": true,
+              "verified": true,
+              "countryCode": 91,
+              "phone": "9890425946"
+            }
+          ],
+          "firstName": "Nikhil",
+          "lastName": "Manapure",
+          "emails": [
+            {
+              "active": true,
+              "primary": true,
+              "verified": true,
+              "email": "nikhilmshchs@gmail.com"
+            }
+          ],
+          "username": "nikhilmshchs_gmail_com_38425_20500281",
+          "createdAt": "2019-01-01T17:22:38.528Z",
+          "updatedAt": "2021-01-22T10:02:42.258Z",
+          "uid": "20500281",
+          "__v": 56
+        }
+      },
+      "response_id": "6012f38457751e0fb8162cf6",
+      "category": {
+        "form": {
+          "login_required": false,
+          "should_notify": false,
+          "inputs": [
+            {
+              "required": false,
+              "type": "text",
+              "enum": [],
+              "display": "Single lineeee",
+              "key": "single-lineeee",
+              "showRegexInput": false
+            },
+            {
+              "required": false,
+              "type": "email",
+              "enum": [],
+              "display": "Email",
+              "regex": "\\S+@\\S+\\.\\S+",
+              "key": "email",
+              "showRegexInput": true
+            },
+            {
+              "required": false,
+              "type": "text",
+              "enum": [],
+              "display": "dfsdf",
+              "key": "dfsdf",
+              "showRegexInput": false
+            }
+          ],
+          "available_assignees": [
+            "5b9b98150df588546aaea6d2",
+            "5c45d78395d7504f76c2cb37"
+          ],
+          "_id": "5fd72db3dc250f8decfc61b2",
+          "title": "SOme title",
+          "description": "SOme big description",
+          "slug": "some-title",
+          "application_id": "000000000000000000000003",
+          "created_on": {
+            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
+            "platform": "web",
+            "meta": {
+              "browser": {
+                "name": "Chrome",
+                "version": "87.0.4280.88"
+              },
+              "os": {
+                "name": "macOS",
+                "version": "10.15.6",
+                "versionName": "Catalina"
+              },
+              "platform": {
+                "type": "desktop",
+                "vendor": "Apple"
+              },
+              "engine": {
+                "name": "Blink"
+              }
+            }
+          },
+          "created_by": "5d1363adf599d850df93175e",
+          "createdAt": "2020-12-14T09:17:39.953Z",
+          "updatedAt": "2021-01-28T18:48:07.717Z",
+          "__v": 0
+        },
+        "key": "some-title",
+        "display": "SOme title"
+      },
+      "ticket_id": "43",
+      "createdAt": "2021-01-28T17:25:25.013Z",
+      "updatedAt": "2021-01-28T17:25:33.396Z",
+      "__v": 0,
+      "video_room_id": "6012f38557751ee8fc162cf7"
+    }
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getParticipantsInsideVideoRoom
+Get participants of a specific Video Room using it's unique name
+
+
+
+```javascript
+// Promise
+const promise = lead.getParticipantsInsideVideoRoom({  uniqueName : value });
+
+// Async/Await
+const data = await lead.getParticipantsInsideVideoRoom({  uniqueName : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| uniqueName | string | yes | Unique name of Video Room |  
+
+
+
+Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
+
+*Returned Response:*
+
+
+
+
+[GetParticipantsInsideVideoRoomResponse](#GetParticipantsInsideVideoRoomResponse)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "participants": []
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getTokenForVideoRoom
+Get Token to join a specific Video Room using it's unqiue name
+
+
+
+```javascript
+// Promise
+const promise = lead.getTokenForVideoRoom({  uniqueName : value });
+
+// Async/Await
+const data = await lead.getTokenForVideoRoom({  uniqueName : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| uniqueName | string | yes | Unique name of Video Room |  
+
+
+
+Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
+
+*Returned Response:*
+
+
+
+
+[GetTokenForVideoRoomResponse](#GetTokenForVideoRoomResponse)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Default</i></summary>
+
+```json
+{
+  "value": {
+    "access_token": "your_token_to_the_room"
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+ 
+ 
+ #### [TicketList](#TicketList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[Ticket](#Ticket)] |  no  | List of tickets |
+ | filters | [Filter](#Filter) |  no  | All the filters available for tickets |
+ | page | [Page](#Page) |  no  | Describes the pagination state |
+
+---
+
+
+ 
+ 
+ #### [Page](#Page)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | item_total | number |  no  |  |
+ | next_id | string |  no  |  |
+ | has_previous | boolean |  no  |  |
+ | has_next | boolean |  no  |  |
+ | current | number |  no  |  |
+ | type | string |  yes  |  |
+ | size | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TicketHistoryList](#TicketHistoryList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[TicketHistory](#TicketHistory)] |  no  | List of ticket history |
+ | page | [Page](#Page) |  no  | Describes the pagination state |
+
+---
+
+
+ 
+ 
+ #### [CustomFormList](#CustomFormList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[CustomForm](#CustomForm)] |  no  | List of forms |
+ | page | [Page](#Page) |  no  | Describes the pagination state |
+
+---
+
+
+ 
+ 
+ #### [CreateCustomFormPayload](#CreateCustomFormPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | slug | string |  yes  | Slug for the form |
+ | title | string |  yes  | Title for the form |
+ | inputs | [string] |  yes  | List of all the form components |
+ | description | string |  no  | Description of the form |
+ | header_image | string |  no  | Header image that is to be shown for the form |
+ | priority | [PriorityEnum](#PriorityEnum) |  yes  | Describes the priority of the tickets created by the form |
+ | should_notify | boolean |  no  | Indicates if staff should be notified when a response is received |
+ | success_message | string |  no  | Success message that will be shown on submission |
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) |  no  | Describes how polling will be done for the tickets createds |
+
+---
+
+
+ 
+ 
+ #### [EditCustomFormPayload](#EditCustomFormPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | title | string |  yes  | Title for the form |
+ | inputs | [string] |  yes  | List of all the form components |
+ | description | string |  no  | Description of the form |
+ | priority | [PriorityEnum](#PriorityEnum) |  yes  | Describes the priority of the tickets created by the form |
+ | header_image | string |  no  | Header image that is to be shown for the form |
+ | should_notify | boolean |  no  | Indicates if staff should be notified when a response is received |
+ | login_required | boolean |  no  | Denotes if login is required to make a form response submission |
+ | success_message | string |  no  | Success message that will be shown on submission |
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) |  no  | Describes how polling will be done for the tickets createds |
+
+---
+
+
+ 
+ 
+ #### [EditTicketPayload](#EditTicketPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | content | [TicketContent](#TicketContent) |  no  | Ticket conetent details |
+ | category | string |  no  | Category assigned to the ticket |
+ | sub_category | string |  no  | Sub-category assigned to the ticket |
+ | source | string |  no  | Denotes if the ticket was created at company or application level |
+ | status | string |  no  | Denotes in what state is the ticket |
+ | priority | [PriorityEnum](#PriorityEnum) |  no  | Denotes the priority of ticket |
+ | assigned_to | [AgentChangePayload](#AgentChangePayload) |  no  | Details of support staff to whom ticket is assigned |
+ | tags | [string] |  no  | Tags relevant to ticket |
+
+---
+
+
+ 
+ 
+ #### [AgentChangePayload](#AgentChangePayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | agent_id | string |  yes  | Agent's unique ID |
+
+---
+
+
+ 
+ 
+ #### [CreateVideoRoomResponse](#CreateVideoRoomResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | unique_name | string |  yes  | Video Room's unique name |
+
+---
+
+
+ 
+ 
+ #### [CloseVideoRoomResponse](#CloseVideoRoomResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | success | boolean |  yes  | Denotes if operation was successfully |
+
+---
+
+
+ 
+ 
+ #### [CreateVideoRoomPayload](#CreateVideoRoomPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | unique_name | string |  yes  | Ticket id |
+ | notify | [[NotifyUser](#NotifyUser)] |  no  | List of people to be notified |
+
+---
+
+
+ 
+ 
+ #### [NotifyUser](#NotifyUser)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | country_code | string |  yes  | Country code |
+ | phone_number | string |  yes  | Phone number |
+
+---
+
+
+ 
+ 
+ #### [Filter](#Filter)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | priorities | [[Priority](#Priority)] |  yes  | List of possible priorities for tickets |
+ | categories | [[TicketCategory](#TicketCategory)] |  no  | List of possible categories for tickets |
+ | statuses | [[Status](#Status)] |  yes  | List of possible statuses for tickets |
+ | assignees | [string] |  yes  | List of support staff availble for tickets assignment |
+
+---
+
+
+ 
+ 
+ #### [TicketHistoryPayload](#TicketHistoryPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | value | string |  yes  | Details of history event |
+ | type | [HistoryTypeEnum](#HistoryTypeEnum) |  yes  | Type of history event |
+
+---
+
+
+ 
+ 
+ #### [CustomFormSubmissionPayload](#CustomFormSubmissionPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | response | [string] |  yes  | Form response |
+ | attachments | [[TicketAsset](#TicketAsset)] |  no  | List of all attachments related to the form |
+
+---
+
+
+ 
+ 
+ #### [GetTokenForVideoRoomResponse](#GetTokenForVideoRoomResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | access_token | string |  yes  | Access token to be used for video room |
+
+---
+
+
+ 
+ 
+ #### [GetParticipantsInsideVideoRoomResponse](#GetParticipantsInsideVideoRoomResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | participants | [[Participant](#Participant)] |  yes  | List of participants of the video room |
+
+---
+
+
+ 
+ 
+ #### [Participant](#Participant)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | user | [UserSchema](#UserSchema) |  no  | Details of participant |
+ | identity | string |  no  | Unique identifier of participant |
+ | status | string |  no  | Status of participant |
+
+---
+
+
+ 
+ 
+ #### [UserSchema](#UserSchema)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | first_name | string |  no  | First name |
+ | last_name | string |  no  | Last name |
+ | phone_numbers | [[PhoneNumber](#PhoneNumber)] |  no  | List of phone numbers |
+ | emails | [[Email](#Email)] |  no  | List of email addresses |
+ | gender | string |  no  | Gender of user |
+ | active | boolean |  no  | Is account active |
+ | profile_pic_url | string |  no  | URL for profile pic |
+ | username | string |  no  | username of user |
+ | account_type | string |  no  | Type of account |
+ | uid | string |  no  | Unique identifier of user |
+ | debug | [Debug](#Debug) |  no  | Used for debugging |
+ | has_old_password_hash | boolean |  no  | Denotes if user has old password hash |
+ | _id | string |  no  | Unique identifier of user |
+ | created_at | string |  no  | Time of user creation |
+ | updated_at | string |  no  | Last time of user details update |
+
+---
+
+
+ 
+ 
+ #### [PhoneNumber](#PhoneNumber)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | active | boolean |  no  | Denotes if the phone number is active |
+ | primary | boolean |  no  | Denotes it's the primary phone number for the account |
+ | verified | boolean |  no  | Denotes it's a verified phone number |
+ | phone | string |  no  | Phone number |
+ | country_code | number |  no  | Country code |
+
+---
+
+
+ 
+ 
+ #### [Email](#Email)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | primary | boolean |  no  | Denotes it's the primary email for the account |
+ | verified | boolean |  no  | Denotes it's a verified email |
+ | email | string |  no  | Email Address |
+ | active | boolean |  no  | Denotes if the email is active |
+
+---
+
+
+ 
+ 
+ #### [Debug](#Debug)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | source | string |  no  | Source of user |
+ | platform | string |  no  | Platform of user |
+
+---
+
+
+ 
+ 
+ #### [SubmitCustomFormResponse](#SubmitCustomFormResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | message | string |  yes  | Success message for form submission |
+ | ticket | [Ticket](#Ticket) |  yes  | Ticket created on form submission |
+
+---
+
+
+ 
+ 
+ #### [TicketContext](#TicketContext)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | application_id | string |  no  | Application ID related to the ticket |
+ | company_id | string |  yes  | Company ID related to the ticket |
+
+---
+
+
+ 
+ 
+ #### [CreatedOn](#CreatedOn)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | user_agent | string |  yes  | Useragent details |
+
+---
+
+
+ 
+ 
+ #### [TicketAsset](#TicketAsset)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display | string |  no  | Display text for asset |
+ | value | string |  yes  | To be used for details |
+ | type | [TicketAssetTypeEnum](#TicketAssetTypeEnum) |  yes  | Type of asset |
+
+---
+
+
+ 
+ 
+ #### [TicketContent](#TicketContent)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | title | string |  yes  | Title for ticket |
+ | description | string |  no  | Long description of issue |
+ | attachments | [[TicketAsset](#TicketAsset)] |  no  | List of all attachments related to the ticket |
+
+---
+
+
+ 
+ 
+ #### [AddTicketPayload](#AddTicketPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | created_by | string |  no  | Creator of the ticket |
+ | status | string |  no  | Status of the ticket |
+ | priority | [PriorityEnum](#PriorityEnum) |  no  | Priority of the ticket |
+ | category | string |  yes  | Category of the ticket |
+ | content | [TicketContent](#TicketContent) |  yes  | Content for the ticket |
+ | _custom_json | string |  no  | optional custom data that needs to be sent |
+
+---
+
+
+ 
+ 
+ #### [Priority](#Priority)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | key | [PriorityEnum](#PriorityEnum) |  yes  | Key for priority |
+ | display | string |  yes  | Display text for priority |
+ | color | string |  yes  | Color for priority |
+
+---
+
+
+ 
+ 
+ #### [Status](#Status)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | key | string |  yes  | Key for status |
+ | display | string |  yes  | Display text for status |
+ | color | string |  yes  | Color for status |
+
+---
+
+
+ 
+ 
+ #### [TicketFeedbackForm](#TicketFeedbackForm)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | title | string |  yes  | Feedback form title that will be shown to the user |
+ | display | [string] |  no  | List of all the form fields |
+
+---
+
+
+ 
+ 
+ #### [TicketFeedbackList](#TicketFeedbackList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[TicketFeedback](#TicketFeedback)] |  no  | List of all ticket feedback for the ticket |
+
+---
+
+
+ 
+ 
+ #### [TicketFeedbackPayload](#TicketFeedbackPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | form_response | string |  no  | Key-value pairs of all the form fields and their response |
+
+---
+
+
+ 
+ 
+ #### [SubmitButton](#SubmitButton)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | title | string |  yes  | Title for submit button |
+ | title_color | string |  yes  | Title color submit button |
+ | background_color | string |  yes  | Color for submit button |
+
+---
+
+
+ 
+ 
+ #### [PollForAssignment](#PollForAssignment)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | duration | number |  yes  | Duration for polling of staff |
+ | message | string |  yes  | Message for polling |
+ | success_message | string |  yes  | Message for successful polling |
+ | failure_message | string |  yes  | Message if polling failed |
+
+---
+
+
+ 
+ 
+ #### [CustomForm](#CustomForm)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | application_id | string |  yes  | Application ID for form |
+ | slug | string |  yes  | Slug for the form, which is to be used for accessing the form |
+ | header_image | string |  no  | Form header image that will be shown to the user |
+ | title | string |  yes  | Form title that will be shown to the user |
+ | description | string |  no  | Form description that will be shown to the user |
+ | priority | [Priority](#Priority) |  yes  | Sets priority of tickets created by form response |
+ | login_required | boolean |  yes  | Denotes if login is required to make a form response submission |
+ | should_notify | boolean |  yes  | Denotes if new response submission for the form should be notified to the assignees |
+ | success_message | string |  no  | Message that is to be shown on succesfull form response submission |
+ | submit_button | [SubmitButton](#SubmitButton) |  no  | Details for submit button |
+ | inputs | [string] |  yes  | List of all the form fields |
+ | created_on | [CreatedOn](#CreatedOn) |  no  | Gives details of when the form was created |
+ | poll_for_assignment | [PollForAssignment](#PollForAssignment) |  no  | Details of how polling should be done for support |
+ | _id | string |  yes  | Unique identifier for the form |
+
+---
+
+
+ 
+ 
+ #### [CommunicationDetails](#CommunicationDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | type | string |  no  | Enum type for the communication method |
+ | title | string |  no  | Title for the communication method |
+ | value | string |  no  | Value for the communication method |
+ | description | string |  no  | Short description for the communication method |
+ | enabled | boolean |  no  | Denotes if this communication method has to be shown |
+
+---
+
+
+ 
+ 
+ #### [SupportGeneralConfig](#SupportGeneralConfig)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | _id | string |  no  | Unique id |
+ | support_email | [CommunicationDetails](#CommunicationDetails) |  no  | Support e-mail details |
+ | support_phone | [CommunicationDetails](#CommunicationDetails) |  no  | Support Phone number details |
+ | support_faq | [CommunicationDetails](#CommunicationDetails) |  no  | Support FAQ details |
+ | show_communication_info | boolean |  no  | Denotes if support communication info should be shown |
+ | support_communication | [CommunicationDetails](#CommunicationDetails) |  no  | Support communication array list details |
+ | show_support_dris | boolean |  no  | Denotes if support DRIS info should be shown |
+ | integration | string |  no  | Contains integrations basic information |
+
+---
+
+
+ 
+ 
+ #### [FeedbackForm](#FeedbackForm)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | inputs | string |  no  | Input details for the feed back form |
+ | title | string |  no  | Title for the feed back form |
+ | timestamps | string |  no  | Gives details of category releted data |
+
+---
+
+
+ 
+ 
+ #### [TicketSubCategory](#TicketSubCategory)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | key | string |  yes  | Key for sub-category |
+ | display | string |  yes  | Display text for sub-category |
+ | sub_categories | [TicketSubCategory](#TicketSubCategory) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TicketCategory](#TicketCategory)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display | string |  yes  | Category display value identifier |
+ | key | string |  yes  | Category key value identifier |
+ | sub_categories | [TicketCategory](#TicketCategory) |  no  | Support category array list details |
+ | group_id | number |  no  | Group id of category releted data |
+ | feedback_form | [FeedbackForm](#FeedbackForm) |  no  | Support category array list details |
+
+---
+
+
+ 
+ 
+ #### [CategoryData](#CategoryData)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | list | [TicketCategory](#TicketCategory) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [IntegrationConfig](#IntegrationConfig)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | _id | string |  no  | Unique id |
+ | integration_type | string |  yes  | Enum string values for integration |
+ | base_url | string |  no  | Integration base url for validate and create ticket |
+ | create_ticket_apikey | string |  no  | Integration apikey to validate and create ticket |
+ | update_ticket_apikey | string |  no  | Integration apikey to update ticket |
+ | category_sync_apikey | string |  no  | Integration apikey to sync category of selected type |
+ | category_data | [CategoryData](#CategoryData) |  no  | Support category array list details |
+ | webhook_apikey | string |  no  | Integration webhook apikey to got callbacks from integration type dashboard like freshdesk, etc |
+ | config_completed | boolean |  no  | Denotes the current intergration is completed or partially done |
+ | allow_ticket_creation | boolean |  yes  | Denotes ticket creation enable or disable on platform |
+ | show_listing | boolean |  yes  | Denotes ticket listing enable or disable on platform |
+
+---
+
+
+ 
+ 
+ #### [FeedbackResponseItem](#FeedbackResponseItem)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display | string |  yes  | Question/Title of the form field |
+ | key | string |  yes  | Key of the form field |
+ | value | string |  yes  | User response value for the form field |
+
+---
+
+
+ 
+ 
+ #### [TicketFeedback](#TicketFeedback)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | _id | string |  yes  | Unique identifier for the feedback |
+ | ticket_id | string |  yes  | Readable ticket number |
+ | company_id | string |  yes  | Company id for which ticket was raised |
+ | response | [[FeedbackResponseItem](#FeedbackResponseItem)] |  yes  |  |
+ | category | string |  no  | Category of the ticket |
+ | user | string |  no  | User who submitted the feedback |
+ | updated_at | string |  no  | Time when the feedback was last updated |
+ | created_at | string |  no  | Time when the feedback was created |
+
+---
+
+
+ 
+ 
+ #### [TicketHistory](#TicketHistory)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | type | string |  yes  | Type of the history event |
+ | value | string |  yes  | Data of the history event |
+ | ticket_id | string |  yes  | Readable ticket number |
+ | created_on | [CreatedOn](#CreatedOn) |  no  | Time of creation of the history event |
+ | created_by | string |  no  | User who created the history event |
+ | _id | string |  yes  | Unique identifier of the history event |
+ | updated_at | string |  no  | Time of last update of the history event |
+ | created_at | string |  no  | Time of creation of the history event |
+
+---
+
+
+ 
+ 
+ #### [Ticket](#Ticket)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | context | [TicketContext](#TicketContext) |  no  | Details of company and application realated to the ticket |
+ | created_on | [CreatedOn](#CreatedOn) |  no  | Details of company and application realated to the ticket |
+ | response_id | string |  no  | Details of company and application realated to the ticket |
+ | content | [TicketContent](#TicketContent) |  no  | Ticket conetent details |
+ | category | string |  yes  | Category assigned to the ticket |
+ | sub_category | string |  no  | Sub-category assigned to the ticket |
+ | source | [TicketSourceEnum](#TicketSourceEnum) |  yes  | Denotes if the ticket was created at company or application level |
+ | status | [Status](#Status) |  yes  | Denotes in what state is the ticket |
+ | priority | [Priority](#Priority) |  yes  | Denotes the priority of ticket |
+ | created_by | string |  no  | User details of ticket creator |
+ | assigned_to | string |  no  | Details of support staff to whom ticket is assigned |
+ | tags | [string] |  no  | Tags relevant to ticket |
+ | _custom_json | string |  no  | custom json relevant to the ticket |
+ | is_feedback_pending | boolean |  no  | Denotes if feedback submission is pending for the ticket |
+ | integration | string |  no  | Integration type and its details of the ticket |
+ | _id | string |  yes  | Unique identifier for the ticket |
+ | updated_at | string |  no  | Time when the ticket was last updated |
+ | created_at | string |  no  | Time when the ticket was created |
+
+---
+
+
+
+
+### Enums
+
+
+
+
+
+ #### [PriorityEnum](#PriorityEnum)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | low | low | This means ticket is low priority |
+ | medium | medium | This means ticket is medium priority |
+ | high | high | This means ticket is high priority |
+ | urgent | urgent | This means ticket is of urgent priority |
+
+---
+
+
+
+ #### [HistoryTypeEnum](#HistoryTypeEnum)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | rating | rating | This means history event is a rating |
+ | log | log | This means history event is a changelog |
+ | comment | comment | This means history event is a comment |
+
+---
+
+
+
+ #### [TicketAssetTypeEnum](#TicketAssetTypeEnum)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | image | image | Denotes asset is of image type |
+ | video | video | Denotes asset is of video type |
+ | file | file | Denotes asset is of file type |
+ | youtube | youtube | Denotes asset is an youtube link |
+ | product | product | Denotes asset is of product type |
+ | collection | collection | Denotes asset is of collection type |
+ | brand | brand | Denotes asset is of brand type |
+ | shipment | shipment | Denotes asset is of shipment type |
+ | order | order | Denotes asset is of order type |
+
+---
+
+
+
+ #### [TicketSourceEnum](#TicketSourceEnum)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | platformPanel | platform_panel | This means it is company level ticket |
+ | salesChannel | sales_channel | This means it is a application/sales channel level ticket |
+
+---
+
+
+
+ #### [TicketIntegrationDetails](#TicketIntegrationDetails)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | defaultCase | default | This means it is default level ticket integration |
+ | freshdesk | freshdesk | This means it is default level freshdesk integration |
+ | kapture | kapture | This means it is default level kapture integration |
+
+---
+
+
+
+
+
+