Merge pull request #67 from Cox-Automotive/template-fields

updates types for getAllAWSRoleTypes

API.md

@@ -191,6 +191,7 @@ Returns a Promise for an array of all available role types (AWS IAM role types,
 - props <code>Object</code> - An object containing the following properties
     - .baseUrl <code>string</code> - The base URL of the ALKS service
     - .accessToken <code>string</code> - The OAuth2 access token used to authorize the request
+    - [.getDynamicValues] <code>boolean</code> - Whether to include the names of any template variables in the response (defaults to false)
 
 **Example**  
 ```js
@@ -201,6 +202,16 @@ alks.getAllAWSRoleTypes({
   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship
 })
 ```
+**Example**  
+```js
+alks.getAllAWSRoleTypes({
+  baseUrl: 'https://your.alks-host.com',
+  accessToken: 'abc123',
+  getDynamicValues: true,
+}).then((roleTypes) {
+  // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship, roleTypes[i].templateVariables[i]
+})
+```
 <a name="alks+getAWSRoleTypes"></a>
 
 ### ~~alks.getAWSRoleTypes(props) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code>~~

dist/alks.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.11.1";
+var version = "1.11.2";
 
 const Buffer = require('buffer').Buffer;
 const fetch = require('node-fetch');
@@ -204,6 +204,7 @@ class alks {
    * @param {Object} props - An object containing the following properties
    * @param {string} props.baseUrl - The base URL of the ALKS service
    * @param {string} props.accessToken - The OAuth2 access token used to authorize the request
+   * @param {boolean} [props.getDynamicValues] - Whether to include the names of any template variables in the response (defaults to false)
    * @returns {Promise<Array<awsRoleType>>}
    * @example
    * alks.getAllAWSRoleTypes({
@@ -212,9 +213,19 @@ class alks {
     * }).then((roleTypes) {
     *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship
     * })
+    * 
+    * @example
+    * alks.getAllAWSRoleTypes({
+    *   baseUrl: 'https://your.alks-host.com',
+    *   accessToken: 'abc123',
+    *   getDynamicValues: true,
+    * }).then((roleTypes) {
+    *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship, roleTypes[i].templateVariables[i]
+    * })
     */
   getAllAWSRoleTypes(props) {
-    return(this._doFetch('allAwsRoleTypes', props, 'GET').then(results => results.roleTypes))
+    const url = props.getDynamicValues ? 'allAwsRoleTypes' : 'allAwsRoleTypes?getDynamicValues=true';
+    return(this._doFetch(url, props, 'GET').then(results => results.roleTypes))
   }
 
   /**

dist/alks.esm.js

@@ -1,4 +1,4 @@
-var version = "1.11.1";
+var version = "1.11.2";
 
 const fetch = window.fetch.bind(window);
 
@@ -201,6 +201,7 @@ class alks {
    * @param {Object} props - An object containing the following properties
    * @param {string} props.baseUrl - The base URL of the ALKS service
    * @param {string} props.accessToken - The OAuth2 access token used to authorize the request
+   * @param {boolean} [props.getDynamicValues] - Whether to include the names of any template variables in the response (defaults to false)
    * @returns {Promise<Array<awsRoleType>>}
    * @example
    * alks.getAllAWSRoleTypes({
@@ -209,9 +210,19 @@ class alks {
     * }).then((roleTypes) {
     *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship
     * })
+    * 
+    * @example
+    * alks.getAllAWSRoleTypes({
+    *   baseUrl: 'https://your.alks-host.com',
+    *   accessToken: 'abc123',
+    *   getDynamicValues: true,
+    * }).then((roleTypes) {
+    *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship, roleTypes[i].templateVariables[i]
+    * })
     */
   getAllAWSRoleTypes(props) {
-    return(this._doFetch('allAwsRoleTypes', props, 'GET').then(results => results.roleTypes))
+    const url = props.getDynamicValues ? 'allAwsRoleTypes' : 'allAwsRoleTypes?getDynamicValues=true';
+    return(this._doFetch(url, props, 'GET').then(results => results.roleTypes))
   }
 
   /**

dist/alks.umd.js

@@ -4,7 +4,7 @@
   (global = global || self, global.alks = factory());
 }(this, function () { 'use strict';
 
-  var version = "1.11.1";
+  var version = "1.11.2";
 
   var fetch = window.fetch.bind(window);
 
@@ -207,6 +207,7 @@
    * @param {Object} props - An object containing the following properties
    * @param {string} props.baseUrl - The base URL of the ALKS service
    * @param {string} props.accessToken - The OAuth2 access token used to authorize the request
+   * @param {boolean} [props.getDynamicValues] - Whether to include the names of any template variables in the response (defaults to false)
    * @returns {Promise<Array<awsRoleType>>}
    * @example
    * alks.getAllAWSRoleTypes({
@@ -215,9 +216,19 @@
     * }).then((roleTypes) {
     * // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship
     * })
+    * 
+    * @example
+    * alks.getAllAWSRoleTypes({
+    * baseUrl: 'https://your.alks-host.com',
+    * accessToken: 'abc123',
+    * getDynamicValues: true,
+    * }).then((roleTypes) {
+    * // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship, roleTypes[i].templateVariables[i]
+    * })
     */
   alks.prototype.getAllAWSRoleTypes = function getAllAWSRoleTypes (props) {
-    return(this._doFetch('allAwsRoleTypes', props, 'GET').then(function (results) { return results.roleTypes; }))
+    var url = props.getDynamicValues ? 'allAwsRoleTypes' : 'allAwsRoleTypes?getDynamicValues=true';
+    return(this._doFetch(url, props, 'GET').then(function (results) { return results.roleTypes; }))
   };
 
   /**

index.d.ts

@@ -78,6 +78,7 @@ declare namespace ALKS {
     defaultArns: string[];
     trustRelationship: object;
     instanceProfile: boolean;
+    templateVariables?: string[];
   }
 
   export interface MachineIdentity {
@@ -203,7 +204,9 @@ declare namespace ALKS {
 
   export type RevokeProps = RevokeByIdProps | RevokeByValueProps;
 
-  export interface GetAllAWSRoleTypesProps extends Partial<AlksProps> {}
+  export interface GetAllAWSRoleTypesProps extends Partial<AlksProps> {
+    getDynamicValues?: boolean;
+  }
 
   export interface AddRoleMachineIdentityProps extends Partial<AlksProps> {
     roleARN: string;

src/alks.js

@@ -203,6 +203,7 @@ class alks {
    * @param {Object} props - An object containing the following properties
    * @param {string} props.baseUrl - The base URL of the ALKS service
    * @param {string} props.accessToken - The OAuth2 access token used to authorize the request
+   * @param {boolean} [props.getDynamicValues] - Whether to include the names of any template variables in the response (defaults to false)
    * @returns {Promise<Array<awsRoleType>>}
    * @example
    * alks.getAllAWSRoleTypes({
@@ -211,9 +212,19 @@ class alks {
     * }).then((roleTypes) {
     *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship
     * })
+    * 
+    * @example
+    * alks.getAllAWSRoleTypes({
+    *   baseUrl: 'https://your.alks-host.com',
+    *   accessToken: 'abc123',
+    *   getDynamicValues: true,
+    * }).then((roleTypes) {
+    *   // roleTypes[i].roleTypeName, roleTypes[i].defaultArns, roleTypes[i].trustRelationship, roleTypes[i].templateVariables[i]
+    * })
     */
   getAllAWSRoleTypes(props) {
-    return(this._doFetch('allAwsRoleTypes', props, 'GET').then(results => results.roleTypes))
+    const url = props.getDynamicValues ? 'allAwsRoleTypes?getDynamicValues=true' : 'allAwsRoleTypes'
+    return(this._doFetch(url, props, 'GET').then(results => results.roleTypes))
   }
 
   /**