From 1d1e9f9c2a20202adea71f4cc00f5ddd4546c5c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:40:43 +0100 Subject: [PATCH 01/46] Fix grammar errors and typos in the descriptions of qrCodeResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 67a650e9..f90ee8cb 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2617,34 +2617,34 @@ components: type: string example: "https://pps.whatsapp.net/v/t61.24694-24/s96x96/71527172_751740171986704_2078049712831220364_n.jpg?oe=5E2168E9&oh=174efd2076218dff633a1e748beac190" qrCodeResponse: - description: Single QR code response + description: A single QR code response type: object properties: code: - description: QR code + description: A QR code type: string example: "VETO8Y3SYCSFH1" createdAt: - description: Date and time the note is created + description: The date and time the QR code is created type: string format: date-time example: '2020-03-11T19:53:02.000000Z' image: - description: QR image URL + description: A QR image URL type: string format: uri example: "https://scontent.xx.fbcdn.net/..." message: - description: QR message to be displayed + description: A QR message to be displayed type: string example: "I have a question about product ABC" updatedAt: - description: Date and time the note is last updated + description: The date and time the QR code is last updated type: string format: date-time example: '2020-04-11T19:53:02.000000Z' url: - description: QR URL + description: A QR URL type: string format: uri example: "https://wa.me/message/VEKO8Y3SYCSFH1" From e641d03895fe9b7030816bc324a999f147e936a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:19:26 +0100 Subject: [PATCH 02/46] Fix grammar errors and typos in the description of the Contact Management section in Support Inbox API --- third-party/eazy/v1/openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index f90ee8cb..fde97572 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -230,10 +230,10 @@ tags: Operations regarding custom lists of contacts that can be created in the GUI. You may use contact lists to send the same message to several contacts at once while keeping them as individual recipients. - **Black list** + **Blacklist** - Contacts can be black listed so that any messages received from those contacts are ignored. - Also agents will not be able to send messages to blacklisted contacts. + Contacts can be blacklisted so that any messages received from those contacts are ignored. + Also, agents will not be able to send messages to blacklisted contacts. - name: 'Conversation Management' description: | Operations regarding conversations. From f34efba78c26ac59df01206659600c23485c5f0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:46:42 +0100 Subject: [PATCH 03/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts/{contactJid} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index fde97572..44d10096 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1075,15 +1075,15 @@ paths: type: object properties: name: - description: Name of the contact + description: The contact's name type: string example: 'John Doe' reference: - description: Reference of the contact + description: The contact's reference type: string example: 'Customer #545' remarks: - description: Comment for the contact + description: A comment about the contact type: string example: 'VIP' responses: From b2377b00da2ac594c773588f8cbbc86a10445382 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:55:45 +0100 Subject: [PATCH 04/46] Fix grammar errors and typos in the descriptions of listResponse --- third-party/eazy/v1/openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 44d10096..c1dfac09 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2539,7 +2539,7 @@ components: description: Priority of the channel type: integer listResponse: - description: Single list response + description: A single list response type: object properties: jid: @@ -2548,11 +2548,11 @@ components: format: email example: '31611111111@company.com' name: - description: Name of the list + description: The name of the list type: string example: 'Mailing list' remarks: - description: Comment for the list + description: A comment on the list type: string example: 'Support' noteResponse: From 89a681a3e575ef8061a764d73a3c52f4fc20e8af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 22:11:16 +0100 Subject: [PATCH 05/46] Fix grammar errors and typos in the descriptions of noteResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index c1dfac09..a97994c1 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2556,15 +2556,15 @@ components: type: string example: 'Support' noteResponse: - description: Single Note Response + description: A single note response type: object properties: body: - description: Text/Body of the note + description: The text/body of the note type: string example: 'Return order received' createdAt: - description: Date and time the note is created + description: The date and time the note is created type: string format: date-time example: '2020-03-11T19:53:02.000000Z' @@ -2574,7 +2574,7 @@ components: format: email example: 'john@mycompany.com' id: - description: ID of the note + description: The note's ID type: string example: '280cbbe0-c08a-4606-bf8d-a30242c4eaa4' isPinned: @@ -2582,16 +2582,16 @@ components: type: boolean example: false isReadOnly: - description: Is this note read only or not? + description: Is this note read-only? type: boolean example: false updatedAt: - description: Date and time the note is last updated + description: The date and time the note is last updated type: string format: date-time example: '2020-04-11T19:53:02.000000Z' referenceId: - description: Reference ID of the note + description: The note's reference ID type: string example: "CUSTOMER_NUMBER" profileResponse: From e19fdf35a597747979d15b496d7dbe5c639ed428 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 22:21:51 +0100 Subject: [PATCH 06/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts/{contactJid}/notes Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index a97994c1..ecae074a 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1609,11 +1609,11 @@ paths: type: object properties: body: - description: Text/Body of the note. + description: The note's text/body type: string example: 'Customer number #63553' referenceId: - description: Friendly reference name as an ID. + description: A friendly reference name as an ID. type: string example: 'CUSTOMER_NUMBER' responses: From 6ad470a352d584b4664f7cf8a1a1ad72e1f5aaa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 22:33:13 +0100 Subject: [PATCH 07/46] Fix grammar errors and typos in the descriptions of DELETE https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts/{contactJid}/notes/{id} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index ecae074a..b57fc12a 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1713,7 +1713,7 @@ paths: - in: path name: id required: true - description: ID of the node + description: The note's ID schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' From 71233a49be55003e30c85cdbaa9eacccee4acab5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 23:36:36 +0100 Subject: [PATCH 08/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/conversations/{contactJid}/comments --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index b57fc12a..a7a88253 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1204,7 +1204,7 @@ paths: type: object properties: body: - description: Text for the comment + description: The text of the comment type: string example: 'Order #12345 has been delivered' responses: From 2b4204e8a24ad0c7a5bc93f7c4d3fb4a108651d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 23:49:28 +0100 Subject: [PATCH 09/46] Fix grammar errors and typos in the descriptions of GET https://api.cmd.tyntec.com/v3/custom/e96eb049-ec39-4a19-9973-c6f770c4e636/unread --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index a7a88253..396a25e8 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2210,7 +2210,7 @@ paths: - in: query name: agent required: true - description: Agents mail + description: The agent's email address schema: type: string format: email From ebf92d8ccbf0fabf4e314364eceaa5fab3e8b7ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:02:33 +0100 Subject: [PATCH 10/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/messages/{contactJid} --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 396a25e8..c415fec8 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1517,7 +1517,7 @@ paths: type: object properties: message: - description: Outgoing message + description: The outgoing message type: object example: body: Hello world From 95fd5d7f90d00fbe27727ad7c9065583ab38f942 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:10:05 +0100 Subject: [PATCH 11/46] Fix grammar errors and typos in the description of the Webhook Configuration section in Support Inbox API Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index c415fec8..36292a1a 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -263,7 +263,7 @@ tags: description: "" - name: 'Webhook Configuration' description: | - Webhooks are used to receive real-time events like messages and receipts. Multiple webhooks can be defined per channel, each with their own events. + Webhooks are used to receive real-time events like messages and receipts. You can define multiple webhooks per channel, each with its events. Webhooks must always return a *200 OK* response. From 023fa577ef29b5994e9cbc05237bbd1d9d18d5d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:23:16 +0100 Subject: [PATCH 12/46] Fix grammar errors and typos in the description of the Webhook Events section in Support Inbox API --- third-party/eazy/v1/openapi.yaml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 36292a1a..bf8c281f 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -295,18 +295,18 @@ tags: The following events are defined: - | **Name** | **Description** | - | --- | --- | - | custom | Custom event for specific customer purposes | - | echo | Outgoing messages sent by agents or assistants | - | handover | Handover event whenever a conversation is transferred to an assistant or agent | - | label | Label event whenever a conversation is labelled or unlabelledv | - | message | Incoming messages from customers | - | note | Note creation or deletion event | - | postback | Postback event for WhatsApp button templates, Apple list pickers etc | - | receipt | Message receipt event | - | template_pack | Template updates whenever templates are approved, rejected etc. | - | typing | Typing indications when customers are typing a message | + | **Name** | **Description** | + | --- | --- | + | custom | A custom event for specific customer purposes | + | echo | An outgoing message sent by an agent or assistant | + | handover | A handover event whenever a conversation is transferred to an assistant or agent | + | label | A label event whenever a conversation is labelled or unlabelled | + | message | An incoming message from a customer | + | note | A note creation or deletion event | + | postback | A postback event for WhatsApp button templates, Apple list pickers, etc | + | receipt | A message receipt event | + | template_pack | A template update whenever a template is approved, rejected, etc. | + | typing | A typing indication when a customer is typing a message | paths: /keys: get: From 6aa282d7ba09e1de65e94bfaf6dcd3c3e8f6496d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:35:17 +0100 Subject: [PATCH 13/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/webhooks Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index bf8c281f..ece5e942 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2121,7 +2121,7 @@ paths: type: string example: "message" url: - description: URL of the webhook + description: The webhook's URL type: string format: uri example: 'https://your.company.com/webhook' From 75b9caa53b40437b729d74a459b9bc451cab055b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 09:23:10 +0100 Subject: [PATCH 14/46] Fix grammar errors and typos in the descriptions of contactResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index ece5e942..d628c4b4 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2429,7 +2429,7 @@ components: format: string example: 'tyntec' contactResponse: - description: Contact response + description: A contact response type: object properties: names: @@ -2443,19 +2443,19 @@ components: items: $ref: '#/components/schemas/note' phoneNumber: - description: Phone number of the contact + description: The phone number of the contact type: integer example: 31611111111 reference: - description: Reference of the contact + description: A reference to the contact type: string example: 'Customer #545' remarks: - description: Comment for the contact + description: A comment about the contact type: string example: 'VIP' type: - description: Type of the contact + description: A type of contact type: string example: 'INDIVIDUAL' conversationResponse: From 3a8acf6dc2763f375c364181d798c2a8f6d62859 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 09:44:16 +0100 Subject: [PATCH 15/46] Fix grammar errors and typos in the descriptions of businessProfile --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index d628c4b4..c9ddb393 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2717,19 +2717,19 @@ components: type: string example: "https://your.company.com/webhook" businessProfile: - description: WhatsApp for Business profile response + description: A WhatsApp for Business profile response type: object properties: address: - description: Address associated with the profile + description: An address associated with the profile type: string example: "High Street 15, New York" description: - description: Description of the profile + description: A description of the profile type: string example: "YourCompany Ltd." email: - description: email address associated with the WhatsApp for business profile + description: The email address associated with the WhatsApp for business profile type: string format: email example: "info@your-company.com" @@ -2738,7 +2738,7 @@ components: type: string example: "Vertical" websites: - description: Website list of URLs + description: A list of website URLs type: array items: $ref: '#/components/schemas/website' From e9c5d717abe448303c06def20c7fe62029224928 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:47:47 +0100 Subject: [PATCH 16/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/qr-codes --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index c9ddb393..cd9eec16 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1893,7 +1893,7 @@ paths: type: object properties: message: - description: Text/Body of the message. + description: The text/body of the message. type: string example: 'I have a question about product ABC' responses: From 0041878d68526fb050400dd3193bb95457f1273d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 17:01:50 +0100 Subject: [PATCH 17/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/companies/{companyId}/assistants/{jid} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index cd9eec16..8c8b011d 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -639,16 +639,16 @@ paths: type: object properties: color: - description: Color + description: The assistant's avatar color type: integer description: - description: Description of the assistant + description: A description of the assistant type: string name: - description: Name of the assistant + description: The name of the assistant type: string enabled: - description: is the assistant enabled + description: Is the assistant enabled type: boolean responses: 200: From 6ae95773a60c046dcc48d80cc1cc04c7ee7fb093 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:37:56 +0100 Subject: [PATCH 18/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/webhooks/{id} --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 8c8b011d..e97679ce 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2151,7 +2151,7 @@ paths: - in: path name: id required: true - description: ID of the node + description: The ID of the node schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -2166,7 +2166,7 @@ paths: - name properties: name: - description: Name of the webhook to be created + description: The name of the webhook to be created type: string example: 'Support' responses: From 6994cd265ded51c1bd3914c34e189efcbe833149 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:40:15 +0100 Subject: [PATCH 19/46] Fix grammar errors and typos in the descriptions of DELETE https://api.cmd.tyntec.com/v3/channels/{channelJid}/webhooks/{id} --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index e97679ce..605cca58 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2194,7 +2194,7 @@ paths: - in: path name: id required: true - description: ID of the node + description: The ID of the node schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' From 59fbf9f4869ee82d98007ec713128d02302f1e53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 23:44:29 +0100 Subject: [PATCH 20/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/conversations/{contactJid} --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 605cca58..3024cda4 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1285,14 +1285,14 @@ paths: type: string example: 'Label123' status: - description: Status of the conversation + description: The status of the conversation type: string enum: - CLOSED - OPEN example: 'CLOSED' unreadCount: - description: Number of unread messages + description: The number of unread messages type: integer example: 5 responses: From 3736907ee5067531d1852787041c15ecacb97cab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:06:36 +0100 Subject: [PATCH 21/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/templates --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 3024cda4..16c6ab5f 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1990,13 +1990,13 @@ paths: example: 'channelJid@company.com' responses: 200: - description: OK - Check response in example above + description: OK - Check the response in the example above post: summary: Create a template tags: - 'WhatsApp Management' operationId: createTemplate - description: Create a new WhatsApp Business template. Templates can include a header, body, footer and buttons. + description: Create a new WhatsApp Business template. Templates can include a header, body, footer, and buttons. parameters: - in: path name: channelJid @@ -2030,12 +2030,12 @@ paths: type: string example: 'en' name: - description: Name of the template + description: The name of the template type: string example: 'support_after_24hours' responses: 201: - description: Created - Check response in example above + description: Created - Check the response in the example above /channels/{channelJid}/templates/{name}: delete: summary: Delete a template @@ -2804,7 +2804,7 @@ components: components: name: components in: body - description: Array of components to be used in the template + description: An array of components to be used in the template schema: type: string text: From 7c1201543ecc851bf84d82ed09662fcaf64d7a50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:54:47 +0100 Subject: [PATCH 22/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/qr-codes/{code} --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 16c6ab5f..9844ffbf 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1922,7 +1922,7 @@ paths: - in: path name: code required: true - description: QR code + description: A QR code schema: type: string example: 'VETO8Y3SYCSFH1' @@ -1937,7 +1937,7 @@ paths: - message properties: message: - description: Text/Body of the message. + description: The text/body of the message type: string example: 'I have a question about product ABC' responses: From f6f54dc4783686a9d6a242f1f65f7fd75de0eb6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 09:49:06 +0100 Subject: [PATCH 23/46] Fix grammar errors and typos in the descriptions of quickReply --- third-party/eazy/v1/openapi.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 9844ffbf..9dc601b4 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2751,7 +2751,7 @@ components: example: "https://your-company.com" quickRepliesResponse: type: array - description: List of quick replies + description: A list of quick replies items: $ref: '#/components/schemas/quickReply' quickReply: @@ -2763,31 +2763,31 @@ components: properties: category: type: string - description: Custom category + description: A custom category example: Welcome Message createdAt: type: string - description: Creation date of the quick reply + description: The creation date of the quick reply format: date-time example: 2021-07-05T06:20:33.000000Z jids: type: array - description: List of channels the quick reply is assigned to + description: The list of channels the quick reply is assigned to items: - type: string example: 123152345245@whatsapp.eazy.im message: type: string - description: Message of the quick reply + description: The message of the quick reply example: Hi {{1}}, how can we help you? name: type: string - description: Name of the quick reply + description: The name of the quick reply example: welcome updatedAt: type: string format: date-time - description: Last update of the quick reply + description: The last update of the quick reply example: 2021-07-05T06:28:33.000000Z unreadMessagesResponse: type: object From c02cef551807cae753cb16d7e2805f8401334fe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:19:53 +0100 Subject: [PATCH 24/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/profile --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 9dc601b4..c2bae8e9 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1767,7 +1767,7 @@ paths: type: object properties: about: - description: Description of what is this profile about. + description: A description of what is this profile about type: string example: 'Welcome! We are here to help you 24/7' businessProfile: @@ -1775,15 +1775,15 @@ paths: type: object properties: address: - description: Address associated with the profile + description: An address associated with the profile type: string example: "High Street 15, New York" description: - description: Description of the profile + description: A description of the profile type: string example: "YourCompany Ltd." email: - description: email address associated with the WhatsApp for business profile + description: The email address associated with the WhatsApp for business profile type: string format: email example: "info@your-company.com" @@ -2746,7 +2746,7 @@ components: - 'www.company1.com' - 'www.company2.com' website: - description: Website URL + description: A website URL type: string example: "https://your-company.com" quickRepliesResponse: From ec736303df7d6f38424ccbc86d0f38cad469c96e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:09:21 +0100 Subject: [PATCH 25/46] Fix grammar errors and typos in the descriptions of DELETE https://api.cmd.tyntec.com/v3/channels/{channelJid}/templates/{name} --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index c2bae8e9..23a3dfdd 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2055,7 +2055,7 @@ paths: - in: path name: name required: true - description: Name of the template to be deleted + description: The name of the template to be deleted schema: type: string example: 'delivery_notification' From 4107087590c8ebce4651fb93ed77584cbf09ea54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 17:08:56 +0100 Subject: [PATCH 26/46] Fix grammar errors and typos in the descriptions of labelResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 23a3dfdd..3cfa194f 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2523,7 +2523,7 @@ components: type: object properties: color: - description: Color + description: The label's color type: integer example: 8 jid: @@ -2532,11 +2532,11 @@ components: format: email example: '31611111111@company.com' name: - description: Name of the label + description: The label's name type: string example: 'Support' priority: - description: Priority of the channel + description: The label's priority type: integer listResponse: description: A single list response From 2995c4ee2945bc512c7ba3e07cc3abbd31c7c6e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:45:19 +0100 Subject: [PATCH 27/46] Fix grammar errors and typos in the descriptions of GET https://api.cmd.tyntec.com/v3/companies/{companyId}/teams Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 3cfa194f..230517ce 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2388,7 +2388,7 @@ components: format: date-time example: '2020-04-11T19:00:02.000000Z' channelResponse: - description: Channel Response + description: A channel response type: object properties: dataRetentionInDays: @@ -2401,11 +2401,11 @@ components: format: email example: 31611111111@company.com name: - description: Name of the channel + description: The channel's name type: string example: 'WhatApp' priority: - description: Priority of the channel + description: The channel's priority type: integer commentResponse: description: Comment response @@ -2649,16 +2649,16 @@ components: format: uri example: "https://wa.me/message/VEKO8Y3SYCSFH1" teamResponse: - description: Single team response + description: A single team response type: object properties: channels: - description: Array of channels + description: An array of channels type: array items: $ref: '#/components/schemas/channelResponse' color: - description: Color + description: The team's avatar color type: integer example: 8 jid: @@ -2670,7 +2670,7 @@ components: description: Metadata information type: string name: - description: Name of the team + description: The team's name type: string example: "Support" webhookResponse: From 2b00d4f79d9db4180f962277260b9c7138d060f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 23:28:02 +0100 Subject: [PATCH 28/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/automated-messages/{type} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 230517ce..45c10e08 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -935,7 +935,7 @@ paths: - in: path name: type required: true - description: Type of automated message + description: The type of automated message schema: type: string enum: @@ -951,7 +951,7 @@ paths: type: object properties: body: - description: Text of the automated message + description: The text of the automated message type: string example: 'Sorry, we are currently closed. Your question will be answered as soon as possible.' enabled: From b14de0116526b600cd8657e73e80af81e1fc29b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 09:35:58 +0100 Subject: [PATCH 29/46] Fix grammar errors and typos in the descriptions of conversationResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 45c10e08..e71cf693 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2459,25 +2459,25 @@ components: type: string example: 'INDIVIDUAL' conversationResponse: - description: Conversation response + description: A conversation response type: object properties: assignee: - description: Assistant to the agents + description: The assigned responder (either an assistant or agent) type: string example: 'john@mycompany.com' channel: - description: Channel to be used + description: The channel to be used type: string items: $ref: '#/components/schemas/channelResponse' contact: - description: Contact of the conversation + description: The contact of the conversation type: string items: $ref: '#/components/schemas/contact' createdAt: - description: Date and time the conversation is created + description: The date and time the conversation is created type: string format: date-time example: '2019-04-04T15:29:47.000000Z' @@ -2487,29 +2487,29 @@ components: items: $ref: '#/components/schemas/allLabelsResponse' lastMessageReceivedAt: - description: Date and time the last message is received + description: The date and time the last message is received type: string format: date-time example: '2019-04-08T23:55:39.000000Z' lastMessageSentAt: - description: Date and time that the last message is sent + description: The date and time that the last message is sent type: string format: date-time example: '2019-04-07T17:12:00.000000Z' messagesReceived: - description: Number of messages received + description: The number of messages received type: integer example: 12 messagesSent: - description: Number of messages sent + description: The number of messages sent type: integer example: 8 status: - description: Status of the conversation + description: The status of the conversation type: string example: "CLOSED" unreadCount: - description: Number of unread messages + description: The number of unread messages type: integer example: 5 emailsResponse: From cbac282e74b39866d3f5599693a8850414f7c392 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 09:40:38 +0100 Subject: [PATCH 30/46] Fix grammar errors and typos in the descriptions of profileResponse --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index e71cf693..bfbefb69 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2595,25 +2595,25 @@ components: type: string example: "CUSTOMER_NUMBER" profileResponse: - description: WhatsApp for Business profile response + description: A WhatsApp for Business profile response type: object properties: about: - description: Description of what is this profile about. + description: A description of what is this profile about. type: string example: "Welcome! We are here to help you 24/7" businessProfile: $ref: '#/components/schemas/businessProfile' name: - description: Name of the profile + description: The name of the profile type: string example: "YourCompany" phoneNumber: - description: Phone number associated with the WhatsApp for Business profile + description: The phone number associated with the WhatsApp for Business profile type: integer example: 31612345678 pictureUrl: - description: URL of the picture used in the profile + description: The URL of the picture used in the profile type: string example: "https://pps.whatsapp.net/v/t61.24694-24/s96x96/71527172_751740171986704_2078049712831220364_n.jpg?oe=5E2168E9&oh=174efd2076218dff633a1e748beac190" qrCodeResponse: From 5b285c42969472d6be257c319ba076955dcf1804 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:22:06 +0100 Subject: [PATCH 31/46] Fix grammar errors and typos in the descriptions of company IDs --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index bfbefb69..cb1e2bd4 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -379,7 +379,7 @@ paths: - in: path name: id required: true - description: ID of the company + description: The ID of the company schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -401,7 +401,7 @@ paths: - in: path name: companyId required: true - description: ID of the company + description: The ID of the company schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -425,7 +425,7 @@ paths: - in: path name: companyId required: true - description: ID of the company + description: The ID of the company schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -594,7 +594,7 @@ paths: - in: path name: companyId required: true - description: ID of the company + description: The ID of the company schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -618,7 +618,7 @@ paths: - in: path name: companyId required: true - description: ID of the company + description: The ID of the company schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' From 81bd09d2d149f17f0625087965d0544656364dc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 22:29:37 +0100 Subject: [PATCH 32/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts/{contactJid}/notes/{id} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index cb1e2bd4..b99fa99d 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1652,7 +1652,7 @@ paths: - in: path name: id required: true - description: ID of the node + description: The note's ID schema: type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' @@ -1665,7 +1665,7 @@ paths: type: object properties: body: - description: Text/Body of the note. + description: The note's text/body. type: string example: 'Customer number #63553' isPinned: @@ -1673,11 +1673,11 @@ paths: type: boolean example: true isReadOnly: - description: Is this note read only or not? + description: Is this note read-only? type: boolean example: false referenceId: - description: Friendly reference name as an ID. + description: A friendly reference name as an ID. type: string example: 'CUSTOMER_NUMBER' responses: From ad19d9608ed8488e90b9255341aaadec6fe75e44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:38:21 +0100 Subject: [PATCH 33/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/companies/{companyId}/teams --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index b99fa99d..52887978 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -470,7 +470,7 @@ paths: - name properties: name: - description: Name of the team to be created + description: The name of the team to be created type: string example: Support responses: From 648151d5ef273ea43fa7b25e82407b4724706d4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:35:16 +0100 Subject: [PATCH 34/46] Fix grammar errors and typos in the descriptions of the email parameter --- third-party/eazy/v1/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 52887978..3d6b5404 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -432,7 +432,7 @@ paths: - in: path name: email required: true - description: email of the agent + description: The email of the agent schema: type: string format: email From 4f6fac534e0d2aaa21adcca37a0b401a23732008 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Mon, 29 Nov 2021 22:30:37 +0100 Subject: [PATCH 35/46] Fix grammar errors and typos in the descriptions of apiKeyResponse --- third-party/eazy/v1/openapi.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 3d6b5404..2973a0c1 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2296,27 +2296,27 @@ components: format: email example: company@domail.com apiKeyResponse: - description: Current API key response + description: The current API key response type: object properties: cipherKey: description: Cipher Key type: string description: - description: Description for the key or usage of the key + description: A description of the key or usage of the key type: string example: 'Test environment' id: - description: Id of the key + description: The ID of the key type: string example: '509000e9-05c9-43a9-b6f1-70f1c6a5448a' lastUsed: - description: When the key last used + description: When the key was last used type: string format: date-time example: '2020-03-11T19:53:02.000000Z' objects: - description: Array of objects. Check example on the right + description: An array of objects. Check the example on the right type: array items: type: array @@ -2330,7 +2330,7 @@ components: type: string example: 'CHANNEL' whitelist: - description: Array of whitelisted IPs. Check example on the right + description: An array of whitelisted IPs. Check the example on the right type: array items: type: string From 5c591287137bcfb73dc49d0f8220259b8c150d55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:15:58 +0100 Subject: [PATCH 36/46] Fix grammar errors and typos in the descriptions of GET https://api.cmd.tyntec.com/v3/companies/current --- third-party/eazy/v1/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 2973a0c1..2c6b18b2 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -344,7 +344,7 @@ paths: tags: - 'Company Management' operationId: listAllCompanies - description: List of all companies can be requested + description: A list of all companies can be requested responses: 200: description: OK @@ -2416,15 +2416,15 @@ components: type: string example: 'ee487689cac84f972ff1d8d10ed7b64f4148' companyResponse: - description: Company response + description: A company response type: object properties: id: - description: ID of the company + description: The ID of the company type: string example: '458e633a-ab50-445f-9d1f-52afbf720ec3' name: - description: Name of the company + description: The name of the company type: string format: string example: 'tyntec' From 57e99eb6fe7af597564f5a1af868912c2d34eaa8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:27:49 +0100 Subject: [PATCH 37/46] Fix grammar errors and typos in the descriptions of GET https://api.cmd.tyntec.com/v3/companies/{companyId}/agents Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 2c6b18b2..32c07c5a 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -396,7 +396,7 @@ paths: tags: - 'Company Management' operationId: allAgents - description: A list of all agents can be retrieved using the GET method. The objects field specifies to which objects the key has access to. IP whitelisting can be used to restrict originating IP addresses. + description: A list of all agents can be retrieved using the GET method. The objects field specifies to which objects the key has access. IP whitelisting can be used to restrict originating IP addresses. parameters: - in: path name: companyId @@ -2254,23 +2254,23 @@ components: type: object properties: email: - description: email address + description: The agent's email address type: string example: jane@mycompany.com name: - description: Name + description: The agent's name type: object properties: firstName: - description: First Name of the Agent + description: The agent's first name type: string example: Jane fullName: - description: Full Name of the Agent + description: The agent's full name type: string example: Jane Mayers lastName: - description: Last Name of the Agent + description: The agent's last name type: string example: Mayers roles: @@ -2282,7 +2282,7 @@ components: - admin - user status: - description: Status of the agent + description: The agent's availability status type: string enum: - OFFLINE From 1c63fde9793692dfe3bd81a4c79f5fc4cfb4563a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 16:56:57 +0100 Subject: [PATCH 38/46] Fix grammar errors and typos in the descriptions of assistantResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 32c07c5a..76c221a4 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2339,24 +2339,24 @@ components: - '95.95.95.95' - '12.12.12.12' assistantResponse: - description: Single assistant response + description: A single assistant response type: object properties: color: - description: Color + description: The assistant's avatar color type: integer example: 8 description: - description: Role of the Assistant + description: The assistant's role type: string example: 'Sales assistant' jid: - description: Id of the key + description: The assistant's ID type: string format: email example: 'jane@mycompany.com' name: - description: Name of the assistant + description: The assistant's name type: string example: 'Jane Mayer' autoMessageResponse: From 0b63584c46dd3eb5cb61fba9952d32fdbfa995ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:01:07 +0100 Subject: [PATCH 39/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 76c221a4..cd66df63 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -847,10 +847,10 @@ paths: type: object properties: name: - description: Name of the channel + description: The channel's name type: integer priority: - description: Priority of the channel + description: The channel's priority type: integer responses: 200: From b5366d60aeef752f9ed95b10bcc43c69c7a033f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 20:28:57 +0100 Subject: [PATCH 40/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/channels/{channelJid}/profile Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index cd66df63..4f07f827 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -1829,11 +1829,11 @@ paths: type: object properties: description: - description: Description of the profile + description: The description of the profile type: string example: "YourCompany Ltd." email: - description: email address associated with the WhatsApp for business profile + description: The email address associated with the WhatsApp for business profile type: string format: email example: "info@your-company.com" From 046b5e8063fcf0a96013550457c5b3ae9a4bf007 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 21:28:00 +0100 Subject: [PATCH 41/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 4f07f827..05907a1c 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -990,19 +990,19 @@ paths: type: object properties: jid: - description: Contact ID + description: A contact ID type: string example: '31611111111@company.com' name: - description: Name of the contact + description: The contact's name type: string example: 'John Doe' reference: - description: Reference of the contact + description: The contact's reference type: string example: 'Customer #545' remarks: - description: Comment for the contact + description: A comment about the contact type: string example: 'VIP' responses: From dc3ec471fa4b5e6c1e3e98d1413a56888a77f7c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 22:50:38 +0100 Subject: [PATCH 42/46] Fix grammar errors and typos in the descriptions of autoMessageResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 05907a1c..c435ac2b 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2360,15 +2360,15 @@ components: type: string example: 'Jane Mayer' autoMessageResponse: - description: Automated message response + description: An automated message response type: object properties: body: - description: Body/text of the message + description: The body/text of the message type: string example: 'Sorry, we are currently closed. Your question will be answered as soon as possible.' createdAt: - description: When message is created + description: When the message is created type: string format: date-time example: '2020-03-11T19:00:02.000000Z' @@ -2376,14 +2376,14 @@ components: description: Is the message enabled? type: boolean type: - description: Name of the assistant + description: The type of the auto message type: string enum: - 'AWAY' - 'GREETING' example: 'AWAY' updatedAt: - description: When message is last updated + description: When the message is last updated type: string format: date-time example: '2020-04-11T19:00:02.000000Z' From b89383b37c54469b3954c2420a67751f5c2d066f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 17:05:37 +0100 Subject: [PATCH 43/46] Fix grammar errors and typos in the descriptions of POST https://api.cmd.tyntec.com/v3/companies/{companyId}/labels Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index c435ac2b..d97b9e4e 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -681,11 +681,11 @@ paths: type: object properties: description: - description: Description of the label + description: The label's description type: string example: 'Support related questions' name: - description: Name of the label + description: The label's name type: string example: 'Support' responses: From c865f0fd06615521e408d204a141094b1fb71097 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Tue, 18 Jan 2022 17:12:16 +0100 Subject: [PATCH 44/46] Fix grammar errors and typos in the descriptions of PATCH https://api.cmd.tyntec.com/v3/companies/{companyId}/labels/{jid} Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index d97b9e4e..2afe442a 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -750,15 +750,15 @@ paths: type: object properties: color: - description: Color of the label + description: The label color representation type: integer example: 8 name: - description: Friendly name of the label + description: The label's friendly name type: string example: 'Customer support' priority: - description: Priority of the label + description: The label's priority type: integer responses: 200: From f77755dd090b5fca84ebdfff73afd103e2b895a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 00:31:27 +0100 Subject: [PATCH 45/46] Fix grammar errors and typos in the descriptions of webhookResponse Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/openapi.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/third-party/eazy/v1/openapi.yaml b/third-party/eazy/v1/openapi.yaml index 2afe442a..919300af 100644 --- a/third-party/eazy/v1/openapi.yaml +++ b/third-party/eazy/v1/openapi.yaml @@ -2674,18 +2674,18 @@ components: type: string example: "Support" webhookResponse: - description: Webhook response + description: A webhook response type: object properties: assistant: - description: Assistant to the agents + description: An assistant to the agents type: string example: 'john@mycompany.com' cipherKey: - description: Cipher key to be used in the webhook + description: A cipher key to be used in the webhook type: string createdAt: - description: Date and time the Webhook is created + description: The date and time that the webhook is created type: string format: date-time example: '2019-04-04T15:29:47.000000Z' @@ -2694,7 +2694,7 @@ components: type: boolean example: true events: - description: Array of event on the webhooks + description: An array of events on the webhooks type: array items: $ref: '#/components/schemas/events' @@ -2704,16 +2704,16 @@ components: items: example: "'Authorization': 'Bearer SomeApiKey'" id: - description: ID of the event + description: The ID of the event type: string example: '8520d8d6-7b28-4d6f-8631-ecd528a0246d' updatedAt: - description: Date and time that the last message is sent + description: The date and time that the last message is sent type: string format: date-time example: '2019-04-07T17:12:00.000000Z' url: - description: URL of the webhook + description: The URL of the webhook type: string example: "https://your.company.com/webhook" businessProfile: From b6ab8f60fa2ceffb703a5fe1526e743666596450 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Hol=C3=BD?= Date: Wed, 19 Jan 2022 10:06:27 +0100 Subject: [PATCH 46/46] Fix grammar errors and typos in the description of the Web Hook Specifications section in Support Inbox API Co-authored-by: Martin <45198686+ridlees@users.noreply.github.com> --- third-party/eazy/v1/webhook.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/third-party/eazy/v1/webhook.yaml b/third-party/eazy/v1/webhook.yaml index 3d5d9f79..7a59de48 100644 --- a/third-party/eazy/v1/webhook.yaml +++ b/third-party/eazy/v1/webhook.yaml @@ -1,12 +1,12 @@ asyncapi: '2.1.0' info: title: Web Hook Specifications - description: Web Hook Specifications + description: Webhook specifications version: 1.0.0 servers: production: url: 78.110.226.11 - description: Server address of tyntec, the events origin from + description: tyntec's server address - from where the events originate protocol: https channels: "Inbound Message (Basic)":