From 29c304f1f7e470fd0f1133ceea4ff01b34a529f4 Mon Sep 17 00:00:00 2001 From: Geoffrey Casper Date: Thu, 25 Mar 2021 14:17:22 -0400 Subject: [PATCH 1/2] fix(docs): Integrations documentation --- docs/docs/cli/integrations.md | 42 +++++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 1 + 2 files changed, 43 insertions(+) create mode 100644 docs/docs/cli/integrations.md diff --git a/docs/docs/cli/integrations.md b/docs/docs/cli/integrations.md new file mode 100644 index 0000000..b02db6f --- /dev/null +++ b/docs/docs/cli/integrations.md @@ -0,0 +1,42 @@ + +## Overview + +Mailscript provides integrations with the external services Google Drive and Zoom. These integrations provide validated OAuth tokens to Mailscript Actions after the integrations are setup. The provided OAuth tokens can be used to interact directly with the integrated service. + +## Google Drive + +The Google Drive Integration provides an OAuth token with the permissions defined by [drive.files](https://www.googleapis.com/auth/drive.file). This allows for viewing and managing Google Drive files and folders that you have opened or created with this app. + +### Setup + +To setup the Google Drive Integration, simply ensure you are logged in under the CLI with: +``` +mailscript login +``` + +Then, add the Google Drive Integration with the following: +``` +mailscript integrations:add --gdrive +``` + +This will open up your default web browsers with a prompt to sign in to Google. + +### Usage + +To access the Google Drive Integration from an Action, [Variable Interpolation]() is required on `integrations.google`, which returns the Integration's OAuth token. + +Note: The Integration's OAuth token is only provided to Webhook-typed Actions. + +## Zoom + +The Zoom Integration provides an OAuth token. This allows for full access to the Zoom API with your authority. + +Note: This Integration is not currently supported. + +### Setup + +There is currently no easy way to setup the Zoom Integration and is not currently supported. + +### Usage + +Since the Zoom Integration is not suppported yet, Zoom OAuth tokens are not exposed to Mailscript Actions. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 222485b..d2c1c05 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -40,6 +40,7 @@ nav: - Daemon: cli/daemon-tutorial.md - Custom Domains: cli/domains.md - Workflow Variables: cli/workflow-variables.md + - Integrations: cli/integrations.md #- API: api.md #- SDK Clients: sdk-clients.md From a80d47c571262457012ebebbe38c535be0f5ce66 Mon Sep 17 00:00:00 2001 From: Geoffrey Casper Date: Thu, 25 Mar 2021 17:00:00 -0400 Subject: [PATCH 2/2] fix(docs): Minor edits on integrations --- docs/docs/cli/integrations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/cli/integrations.md b/docs/docs/cli/integrations.md index b02db6f..99b1c2a 100644 --- a/docs/docs/cli/integrations.md +++ b/docs/docs/cli/integrations.md @@ -1,7 +1,7 @@ ## Overview -Mailscript provides integrations with the external services Google Drive and Zoom. These integrations provide validated OAuth tokens to Mailscript Actions after the integrations are setup. The provided OAuth tokens can be used to interact directly with the integrated service. +Mailscript provides integrations with external services such as Google Drive and Zoom. These integrations provide validated OAuth tokens to Mailscript Actions after the integrations are setup. The provided OAuth tokens can be used to interact directly with the integrated service. ## Google Drive @@ -9,7 +9,7 @@ The Google Drive Integration provides an OAuth token with the permissions define ### Setup -To setup the Google Drive Integration, simply ensure you are logged in under the CLI with: +To setup the Google Drive Integration, first ensure you are logged in under the CLI with: ``` mailscript login ```