Additional Documentation Revisions

This commit contains additional documentation revisions. Signed-off-by: Lui de la Parra <lui@mutesymphony.com>
Luidog · Jan 11, 2019 · 486f6a3 · 486f6a3
1 parent b4c2c15
commit 486f6a3
Show file tree

Hide file tree

Showing 29 changed files with 518 additions and 431 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/Agent.html b/docs/Agent.html
@@ -1293,7 +1293,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Client.html b/docs/Client.html
@@ -5099,7 +5099,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Connection.html b/docs/Connection.html
@@ -1535,7 +1535,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Credentials.html b/docs/Credentials.html
@@ -317,7 +317,7 @@ <h5>Type:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Data.html b/docs/Data.html
@@ -1007,7 +1007,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/global.html b/docs/global.html
@@ -1251,7 +1251,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/models_agent.model.js.html b/docs/models_agent.model.js.html
@@ -215,7 +215,7 @@ <h1 class="page-title">models/agent.model.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/models_client.model.js.html b/docs/models_client.model.js.html
@@ -949,7 +949,7 @@ <h1 class="page-title">models/client.model.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/models_connection.model.js.html b/docs/models_connection.model.js.html
@@ -259,7 +259,7 @@ <h1 class="page-title">models/connection.model.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/models_credentials.model.js.html b/docs/models_credentials.model.js.html
@@ -84,7 +84,7 @@ <h1 class="page-title">models/credentials.model.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/models_data.model.js.html b/docs/models_data.model.js.html
@@ -176,7 +176,7 @@ <h1 class="page-title">models/data.model.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-Conversion%20Utilities.html b/docs/module-Conversion%20Utilities.html
@@ -1068,7 +1068,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-Transformation%20Service.html b/docs/module-Transformation%20Service.html
@@ -1090,7 +1090,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-filemaker%20utilities.html b/docs/module-filemaker%20utilities.html
@@ -1257,7 +1257,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-request.html b/docs/module-request.html
@@ -412,7 +412,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:56 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/services_container.service.js.html b/docs/services_container.service.js.html
@@ -163,7 +163,7 @@ <h1 class="page-title">services/container.service.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/services_request.service.js.html b/docs/services_request.service.js.html
@@ -126,7 +126,7 @@ <h1 class="page-title">services/request.service.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/services_transform.service.js.html b/docs/services_transform.service.js.html
@@ -182,7 +182,7 @@ <h1 class="page-title">services/transform.service.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/utilities_conversion.utilities.js.html b/docs/utilities_conversion.utilities.js.html
@@ -157,7 +157,7 @@ <h1 class="page-title">utilities/conversion.utilities.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/utilities_filemaker.utilities.js.html b/docs/utilities_filemaker.utilities.js.html
@@ -232,7 +232,7 @@ <h1 class="page-title">utilities/filemaker.utilities.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 12:04:55 GMT-0800 (PST) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 10 2019 15:34:29 GMT-0800 (PST) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/examples/results/field-data-utility-example.json b/examples/results/field-data-utility-example.json
@@ -1,12 +1,12 @@
 [
   {
     "name": "Yoda",
-    "image": "",
+    "image": "https://some-server.com/Streaming_SSL/MainDB/8DBFEFF953E257F0A90C37DD00A50BC98785D7CF03A6AA7B7EEB44CEE1729D3B?RCType=EmbeddedRCFileProcessor",
     "object": "",
     "array": "",
     "height": "",
     "id": "r2d2-c3po-l3-37-bb-8",
-    "imageName": "",
+    "imageName": "placeholder.md",
     "creationAccountName": "obi-wan",
     "creationTimestamp": "05/25/1977 6:00:00",
     "modificationAccountName": "obi-wan",

diff --git a/examples/results/field-data-utility-original-example.json b/examples/results/field-data-utility-original-example.json
@@ -2,12 +2,12 @@
   {
     "fieldData": {
       "name": "Yoda",
-      "image": "",
+      "image": "https://some-server.com/Streaming_SSL/MainDB/ACFA0ADBE69F55BE557B6FAD33DF385D34E9C5B4440C100CCEEB27C27C4946C2?RCType=EmbeddedRCFileProcessor",
       "object": "",
       "array": "",
       "height": "",
       "id": "r2d2-c3po-l3-37-bb-8",
-      "imageName": "",
+      "imageName": "placeholder.md",
       "creationAccountName": "obi-wan",
       "creationTimestamp": "05/25/1977 6:00:00",
       "modificationAccountName": "obi-wan",

diff --git a/examples/results/get-record-example.json b/examples/results/get-record-example.json
@@ -2,13 +2,13 @@
   "data": [
     {
       "fieldData": {
-        "name": "Yoda",
-        "image": "https://some-server.com/Streaming_SSL/MainDB/2782DBD000C6F620935073E24634C02297D9EF32BDD29BEEFF6F98EDC9A78D5F?RCType=EmbeddedRCFileProcessor",
+        "name": "yoda",
+        "image": "",
         "object": "",
         "array": "",
         "height": "",
         "id": "r2d2-c3po-l3-37-bb-8",
-        "imageName": "placeholder.md",
+        "imageName": "",
         "creationAccountName": "obi-wan",
         "creationTimestamp": "05/25/1977 6:00:00",
         "modificationAccountName": "obi-wan",

diff --git a/examples/results/list-records-example.json b/examples/results/list-records-example.json
@@ -3,7 +3,7 @@
     {
       "fieldData": {
         "name": "George Lucas",
-        "image": "https://some-server.com/Streaming_SSL/MainDB/C070AD17B753660A8C3361B4C5E94AFC3717127E40B0692F118D2CA150ED41D7.png?RCType=EmbeddedRCFileProcessor",
+        "image": "https://some-server.com/Streaming_SSL/MainDB/28734A1A6F6734E76E716D34C492BC21B563C21A075FEB8C7EE4CEA0965F0669.png?RCType=EmbeddedRCFileProcessor",
         "object": "",
         "array": "",
         "height": "",

diff --git a/examples/results/record-id-utility-example.json b/examples/results/record-id-utility-example.json
@@ -1,4 +1,4 @@
 [
-  "738318",
-  "738322"
+  "738327",
+  "738330"
 ]
diff --git a/examples/results/record-id-utility-original-example.json b/examples/results/record-id-utility-original-example.json
@@ -2,12 +2,12 @@
   {
     "fieldData": {
       "name": "Yoda",
-      "image": "",
+      "image": "https://some-server.com/Streaming_SSL/MainDB/814F26A93D72F8B747C1CEDAAF570846293EB7CB4410F46161D6C75619DD8BA5?RCType=EmbeddedRCFileProcessor",
       "object": "",
       "array": "",
       "height": "",
       "id": "r2d2-c3po-l3-37-bb-8",
-      "imageName": "",
+      "imageName": "placeholder.md",
       "creationAccountName": "obi-wan",
       "creationTimestamp": "05/25/1977 6:00:00",
       "modificationAccountName": "obi-wan",

diff --git a/examples/templates/README.hbs b/examples/templates/README.hbs
@@ -5,55 +5,11 @@
 
 A FileMaker Data API client designed to allow easier interaction with a FileMaker application from a web environment. This client abstracts the FileMaker 17 Data API into class based methods. 
 
-<!--@license()-->
-<!--/@-->
+[fms-api-client documentation](https://luidog.github.io/fms-api-client/)
 
 ## Table of Contents
-
-- [fms-api-client](#fms-api-client)
-  * [License](#license)
-  * [Table of Contents](#table-of-contents)
-  * [Installation](#installation)
-  * [Usage](#usage)
-    + [Introduction](#introduction)
-    + [Parameter Syntax](#parameter-syntax)
-      - [Script Array Syntax](#script-array-syntax)
-      - [Portals Array Syntax](#portals-array-syntax)
-      - [Data Syntax](#data-syntax)
-      - [Sort Syntax](#sort-syntax)
-      - [Query Syntax](#query-syntax)
-    + [Datastore Connection](#datastore-connection)
-    + [Client Creation](#client-creation)
-    + [Client Use](#client-use)
-    + [Data API Sessions](#data-api-sessions)
-      - [Login Method](#login-method)
-      - [Logout Method](#logout-method)
-    + [Client Methods](#client-methods)
-      - [Create Records](#create-records)
-      - [Get Record Details](#get-record-details)
-      - [List Records](#list-records)
-      - [Find Records](#find-records)
-      - [Edit Records](#edit-records)
-      - [Delete Records](#delete-records)
-      - [Trigger Script](#trigger-script)
-      - [Upload Files](#upload-files)
-      - [Set Session Globals](#set-session-globals)
-    + [Utilities](#utilities)
-      - [recordId Utility](#recordid-utility)
-        * [recordId Utility Results](#recordid-utility-results)
-      - [FieldData Utility](#fielddata-utility)
-        * [FieldData Utility Results](#fielddata-utility-results)
-      - [Transform Utility](#transform-utility)
-        * [Transform Utility Results](#transform-utility-results)
-      - [ContainerData Utility](#containerdata-utility)
-    + [Custom Request Agents, Custom Request Parameters, and Proxies](#custom-request-agents--custom-request-parameters--and-proxies)
-    + [Custom Request Agents](#custom-request-agents)
-    + [Custom Request Parameters](#custom-request-parameters)
-    + [Proxies](#proxies)
-  * [Tests](#tests)
-  * [Dependencies](#-a-name--dependencies--dependencies--a-)
-  * [Development Dependencies](#-a-name--dev-dependencies--dev-dependencies)
-  * [Developer Documentation](#developer-documentation)
+<!--@license()-->
+<!--/@-->
 
 <!--@installation()-->
 ## Installation
@@ -62,6 +18,7 @@ A FileMaker Data API client designed to allow easier interaction with a FileMake
 npm install --save fms-api-client
 ```
 <!--/@-->
+
 ## Usage
 
 ### Introduction
@@ -372,7 +329,7 @@ The fieldData method retrieves the `fieldData`, `recordId`, and `modId` properti
 <!--/@-->
 ##### FieldData Utility Results
 Original:
-<!--@snippet('./examples/utility.examples.js#field-data-utility-original-example', { showSource: true })-->
+<!--@snippet('./examples/results/field-data-utility-original-example.json', { showSource: true })-->
 <!--/@-->
 Transformed:
 <!--@snippet('./examples/results/field-data-utility-example.json', { showSource: true })-->
@@ -412,21 +369,21 @@ The containerData utility will retrieve FileMaker container data by following th
 Result:
 <!--@snippet('./examples/results/container-data-example.json', { showSource: true })-->
 <!--/@-->
-### Custom Request Agents, Custom Request Parameters, and Proxies
+### Additional Client Capabilities
 
 The client has the ability to create custom agents and modify requests parameters or use a proxy. Agents, request parameters, and proxies can be configured either when the client is created or when a request is being made.
 
-### Custom Request Agents
+#### Custom Request Agents
 
 A client can have a custom [Agent](https://nodejs.org/api/http.html#http_class_http_agent). Using a custom request agent will allow you to configure an agent designed for your specific needs. A request agent can be configured to not reject unauthorized request such as those with invalid SSLs, keep the connection alive, or limit the number of sockets to a host. There is no need to create an agent unless theses options are needed.
 
 **Note** If you are using a custom agent you are responsible for destroying that agent with `client.destroy` once the agent is no longer used.
 
-### Custom Request Parameters
+#### Custom Request Parameters
 
 All client methods except `client.login()` and `client.logout()` accept request parameters. These parameters are `request.proxy` and `request.timeout`, `request.agent`. These properties will apply only to the current request. 
 
-### Proxies
+#### Proxies
 
 The client can be configured to use a proxy. The proxy can be configured either for every request by specifying the proxy during the creation of the client, or just for a particular request by specifying the proxy in the request parameters.
 
@@ -441,10 +398,4 @@ npm test
 <!--@dependencies()-->
 <!--/@-->
 <!--@devDependencies()-->
-<!--/@-->
-
-## Developer Documentation
-
-You can find detailed developer documentation on this project here:
-
-[fms-api-client documentation](https://luidog.github.io/fms-api-client/)
+<!--/@-->