docs/global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id="TOKEN_FORMAT"><span class="type-signature"></span>TOKEN_FORMAT<span class="type-signature"> :string</span></h4>


<div class="description">
    The supported formats for the returned OAuth2 token.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>JSON</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">JSON format, for example <code>{"access_token": "..."}</code></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>FORM_URL_ENCODED</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Form URL-encoded, for example <code>access_token=...</code></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="createService"><span class="type-signature"></span>createService<span class="signature">(serviceName)</span><span class="type-signature"> &rarr; {<a href="Service_.html">Service_</a>}</span></h4>
    

<div class="description">
    Creates a new OAuth2 service with the name specified. It's usually best to
create and configure your service once at the start of your script, and then
reference them during the different phases of the authorization flow.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>serviceName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The name of the service.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The service object.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Service_.html">Service_</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="decodeJwt_"><span class="type-signature"></span>decodeJwt_<span class="signature">(jwt)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Decodes and returns the parts of the JWT. The signature is not verified.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The JWT to decode.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The decoded payload.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="encodeChallenge_"><span class="type-signature"></span>encodeChallenge_<span class="signature">(method, codeVerifier)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Encodes a challenge string for PKCE.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>method</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">Encoding method (S256 or plain)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>codeVerifier</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">String to encode</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    BASE64(SHA256(ASCII(codeVerifier)))
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="encodeJwt_"><span class="type-signature"></span>encodeJwt_<span class="signature">(payload, key)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Encodes and signs a JWT.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>payload</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The JWT payload.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>key</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The key to use when generating the signature.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The encoded and signed JWT.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="encodeUrlSafeBase64NoPadding_"><span class="type-signature"></span>encodeUrlSafeBase64NoPadding_<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Wrapper around base64 encoded to strip padding.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Web safe base64 encoded with padding removed.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="extend_"><span class="type-signature"></span>extend_<span class="signature">(destination, source)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Copy all of the properties in the source objects over to the
destination object, and return the destination object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>destination</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The combined object.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>source</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The object who's properties are copied to the
    destination.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://underscorejs.org/#extend">http://underscorejs.org/#extend</a></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A combined object with the desination and source
    properties.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id="getRedirectUri"><span class="type-signature"></span>getRedirectUri<span class="signature">(optScriptId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Returns the redirect URI that will be used for a given script. Often this URI
needs to be entered into a configuration screen of your OAuth provider.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>optScriptId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">The script ID of your script, which can be
    found in the Script Editor UI under "File > Project properties". Defaults
    to the script ID of the script being executed.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The redirect URI.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
    <h4 class="name" id="getServiceNames"><span class="type-signature"></span>getServiceNames<span class="signature">(propertyStore)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
    

<div class="description">
    Gets the list of services with tokens stored in the given property store.
This is useful if you connect to the same API with multiple accounts and
need to keep track of them. If no stored tokens are found this will return
an empty array.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>propertyStore</code></td>
            

            <td class="type">
            
                
<span class="param-type">PropertiesService.Properties</span>


            </td>

            
            <td class="description last">The properties to check.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    The service names.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;string></span>


    </dd>
</dl>

    
    <h4 class="name" id="toLowerCaseKeys_"><span class="type-signature"></span>toLowerCaseKeys_<span class="signature">(obj)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

<div class="description">
    Gets a copy of an object with all the keys converted to lower-case strings.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>obj</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">The object to copy.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A shallow copy of the object with all lower-case keys.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
        <h3 class="subsection-title">Type Definitions</h3>

        
    <h4 class="name" id="tokenHandler"><span class="type-signature"></span>tokenHandler<span class="signature">(tokenPayload)</span><span class="type-signature"> &rarr; {Object}</span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>tokenPayload</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">A hash of parameters to be sent to the token
    URL.
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>code</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The authorization code.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>client_id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The client ID.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>client_secret</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The client secret.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>redirect_uri</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The redirect URI.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>grant_type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">The type of grant requested.</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    A modified hash of parameters to be sent to the token URL.
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Service_.html">Service_</a></li><li><a href="Storage_.html">Storage_</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createService">createService</a></li><li><a href="global.html#decodeJwt_">decodeJwt_</a></li><li><a href="global.html#encodeChallenge_">encodeChallenge_</a></li><li><a href="global.html#encodeJwt_">encodeJwt_</a></li><li><a href="global.html#encodeUrlSafeBase64NoPadding_">encodeUrlSafeBase64NoPadding_</a></li><li><a href="global.html#extend_">extend_</a></li><li><a href="global.html#getRedirectUri">getRedirectUri</a></li><li><a href="global.html#getServiceNames">getServiceNames</a></li><li><a href="global.html#TOKEN_FORMAT">TOKEN_FORMAT</a></li><li><a href="global.html#toLowerCaseKeys_">toLowerCaseKeys_</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>