Conversations Inbox API proofreading #103

radekholy24 · 2021-12-20T15:19:34Z

I have been assigned a task to proofread the API Reference. Peter has suggested to me to create a pull request for all my findings.

third-party/eazy/v1/openapi.yaml

radekholy24 · 2022-01-03T12:55:52Z

third-party/eazy/v1/openapi.yaml

          type: array
          items:
-            $ref: '#/components/schemas/events'
+            $ref: '#/components/schemas/event'


Is this correct?

just see that this is major mistake

it's a list of strings

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 unlabelled

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

third-party/eazy/v1/openapi.yaml

radekholy24 · 2022-01-03T13:37:09Z

third-party/eazy/v1/openapi.yaml

          type: array
          items:
-            $ref: '#/components/schemas/allLabelsResponse'
+            $ref: '#/components/schemas/labelResponse'


Could not test it. Is this correct? Maybe it should be just an array of strings?

third-party/eazy/v1/openapi.yaml

radekholy24 · 2022-01-03T20:06:56Z

third-party/eazy/v1/openapi.yaml

+                message:
+                  description: Outgoing message
+                  type: object
+                  example:
+                    body: Hello world
+                    type: text


Cannot test it. What is the proper fix?

it looks like there is a bigger mistake as the labels, messaging and lists resource are mixed up

I have noticed that you have pushed some changes to this object to the master branch already but still... Doesn't the message object need to have its properties documented?

radekholy24 · 2022-01-03T20:19:45Z

third-party/eazy/v1/openapi.yaml

+      requestBody:
+        description: The message you would like to update
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                body:
+                  description: Text of the automated message
+                  type: string
+                  example: 'Sorry, we are currently closed. Your question will be answered as soon as possible.'
+                enabled:
+                  description: Is the automated message enabled?
+                  type: boolean
+                  example: false


Cannot test it. What is the proper fix? How does the request body look like?

Pushed to the master so I guess that I have guessed that schema right... https://github.com/tyntec/api-collection/pull/106/files#diff-fa1b1ded6b1a42d44b72a651240624ebe14243d63d9999faf2dfac83d70a8ed5R945-R960 Have I?

radekholy24 · 2022-01-04T10:15:27Z

third-party/eazy/v1/openapi.yaml

+    name:
+      description: "Contact's name"
+      type: object
+      properties:
+        firstName: 
+          description: "Contact's first name"
+          type: string
+          example: 'John'
+        fullName:
+          description: "Contact's full name"
+          type: string
+          example: 'John Doe'
+        lastName:
+          description: "Contact's last name"
+          type: string
+          example: 'Doe'


Could not test it. Is this correct? How does the request body look like?

…ies/{companyId}/agents/{email}

…companies/{companyId}/teams/{jid}

…v3/incoming

…channels/{channelJid}/webhooks

…channels/{channelJid}/qr-codes

Co-authored-by: Martin <[email protected]>

radekholy24 · 2022-02-10T07:06:41Z

https://github.com/radekholy24/tyntec-api-collection/blob/proofreading-support-inbox/third-party/eazy/v1/openapi.yaml#L2827

Ad components parameter, it is a string at the moment. Shouldn't it be an array? I cannot test it.

…ls/{channelJid}/contacts/blacklist

radekholy24 · 2022-03-15T21:00:57Z

third-party/eazy/v1/openapi.yaml

      items:
        $ref: '#/components/schemas/email'
      example: [[email protected], [email protected], [email protected]]
+    email:


@ridlees suggests renaming this to jid. What do you think?

radekholy24 · 2022-05-02T11:50:55Z

In contactResponse, there is a notes property that refers #/components/schemas/note. However, there is no note schema. Can you provide the schema?

radekholy24 · 2022-05-02T11:52:12Z

This is now ready to be reviewed. Can you please take a look?

radekholy24 commented Dec 20, 2021

View reviewed changes

third-party/eazy/v1/openapi.yaml Show resolved Hide resolved

radekholy24 commented Jan 3, 2022

View reviewed changes

third-party/eazy/v1/openapi.yaml Show resolved Hide resolved

radekholy24 commented Jan 3, 2022

View reviewed changes

third-party/eazy/v1/openapi.yaml Show resolved Hide resolved

radekholy24 commented Jan 3, 2022

View reviewed changes

third-party/eazy/v1/openapi.yaml Outdated Show resolved Hide resolved

radekholy24 commented Jan 3, 2022

View reviewed changes

third-party/eazy/v1/openapi.yaml Show resolved Hide resolved

radekholy24 commented Jan 3, 2022

View reviewed changes

radekholy24 force-pushed the proofreading-support-inbox branch from 0eb8303 to 9026996 Compare January 3, 2022 21:37

radekholy24 commented Jan 4, 2022

View reviewed changes

radekholy24 added 3 commits January 11, 2022 11:11

Fix reference to response of GET https://api.cmd.tyntec.com/v3/compan…

7782fcd

…ies/{companyId}/agents/{email}

Add version to https://api.cmd.tyntec.com/v3

6c32315

Fix the items of events in webhookResponse

b047869

radekholy24 force-pushed the proofreading-support-inbox branch 3 times, most recently from f0af738 to c5fa8eb Compare January 18, 2022 15:10

radekholy24 added 13 commits January 18, 2022 16:51

Fix the descriptions in the body of PATCH https://api.cmd.tyntec.com/…

aec6545

…companies/{companyId}/teams/{jid}

Fix the type of jids in quickReply

4b2f1b0

Fix the reference to labels items in conversationResponse

af8b00e

Fix the description of GET https://api.cmd.tyntec.com/v3/keys/current

c0dd61f

Fix references to schemas in Support Inbox API

b37c70f

Fix the path of GET https://api.cmd.tyntec.com/v3/keys/current

87c0d7a

Fix the items of objects in apiKeyResponse

d429c59

Fix link to Webhook Configuration in POST https://api.cmd.tyntec.com/…

fb4f1a7

…v3/incoming

Fix the description of the location message in the Support Inbox API

782dd7c

Fix reference to response items of GET https://api.cmd.tyntec.com/v3/…

b1f5de6

…channels/{channelJid}/webhooks

Fix the example of headers in webhookResponse

0c067fe

Fix reference to response items of GET https://api.cmd.tyntec.com/v3/…

a42accc

…channels/{channelJid}/qr-codes

Fix the description of dataRetentionInDays in channelResponse

2b442a5

radekholy24 force-pushed the proofreading-support-inbox branch from c5fa8eb to e226bc9 Compare January 18, 2022 15:51

Document items of names in contactResponse

b72fa31

Co-authored-by: Martin <[email protected]>

radekholy24 force-pushed the proofreading-support-inbox branch 2 times, most recently from 7d2b00d to b72fa31 Compare January 20, 2022 13:25

radekholy24 mentioned this pull request Jan 20, 2022

Conversations Inbox API proofreading (grammar fixes) #108

Open

radekholy24 mentioned this pull request Feb 10, 2022

WIP: fix schema of components in POST https://api.cmd.tyntec.com/v3//channels/{channelJid}/templates radekholy24/tyntec-api-collection#90

Closed

radekholy24 mentioned this pull request Mar 15, 2022

Document items of notes in contactResponse radekholy24/tyntec-api-collection#93

Open

Fix reference to response of GET https://api.cmd.tyntec.com/v3/channe…

e0a27bf

…ls/{channelJid}/contacts/blacklist

radekholy24 commented Mar 15, 2022

View reviewed changes

radekholy24 force-pushed the proofreading-support-inbox branch from a17f586 to e0a27bf Compare March 15, 2022 21:01

radekholy24 mentioned this pull request Mar 15, 2022

Fix reference to response of GET https://api.cmd.tyntec.com/v3/channels/{channelJid}/contacts/blacklist radekholy24/tyntec-api-collection#94

Merged

radekholy24 marked this pull request as ready for review May 2, 2022 11:52

radekholy24 changed the title ~~Support Inbox API proofreading~~ Conversations Inbox API proofreading May 2, 2022

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 unlabelled
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

Uh oh!

Conversations Inbox API proofreading #103

Are you sure you want to change the base?

Conversations Inbox API proofreading #103

Uh oh!

Conversation

radekholy24 commented Dec 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

radekholy24 Jan 3, 2022

Choose a reason for hiding this comment

Uh oh!

coders-kitchen Jan 4, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

radekholy24 Jan 3, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

radekholy24 Jan 3, 2022

Choose a reason for hiding this comment

Uh oh!

coders-kitchen Jan 4, 2022

Choose a reason for hiding this comment

Uh oh!

radekholy24 Jan 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

radekholy24 Jan 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

radekholy24 Jan 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

radekholy24 Jan 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

radekholy24 commented Feb 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

radekholy24 Mar 15, 2022

Choose a reason for hiding this comment

Uh oh!

radekholy24 commented May 2, 2022

Uh oh!

radekholy24 commented May 2, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

radekholy24 commented Dec 20, 2021 •

edited

Loading

radekholy24 Jan 11, 2022 •

edited

Loading

radekholy24 Jan 3, 2022 •

edited

Loading

radekholy24 Jan 11, 2022 •

edited

Loading

radekholy24 Jan 4, 2022 •

edited

Loading

radekholy24 commented Feb 10, 2022 •

edited

Loading