@itentialopensource/adapter-redis_cloud 0.1.1

package/CALLS.md

@@ -0,0 +1,590 @@
+## Using this Adapter
+
+The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
+
+### Generic Adapter Calls
+
+These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">connect()</td>
+    <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">healthCheck(callback)</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Redis_cloud. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">refreshProperties(properties)</td>
+    <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">encryptProperty(property, technique, callback)</td>
+    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Redis_cloud.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
+    <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
+    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
+    <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
+    <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetAdapterQueue(callback)</td>
+    <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
+    <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+
+  <tr>
+    <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
+    <td style="padding:15px">This call will return the results of a healthcheck.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
+    <td style="padding:15px">This call will return the results of a connectivity check.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
+    <td style="padding:15px">This call will return the results of running basic get API calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
+    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
+    <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
+    <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
+    <td style="padding:15px">This call will update the entity cache.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+</table>
+<br>
+
+### Adapter Broker Calls
+
+These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
+    <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevice(deviceName, callback)</td>
+    <td style="padding:15px">This call returns the details of the requested device.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesFiltered(options, callback)</td>
+    <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isAlive(deviceName, callback)</td>
+    <td style="padding:15px">This call returns whether the device status is active</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfig(deviceName, format, callback)</td>
+    <td style="padding:15px">This call returns the configuration for the selected device.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetDeviceCount(callback)</td>
+    <td style="padding:15px">This call returns the count of devices.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+
+
+### Specific Adapter Calls
+
+Specific adapter calls are built based on the API of the Redis_cloud. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUserById(userId, callback)</td>
+    <td style="padding:15px">Information on user identified by user Id</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateUser(userId, body, callback)</td>
+    <td style="padding:15px">Update an existing user by Id</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUserById(userId, callback)</td>
+    <td style="padding:15px">Delete a user from current account</td>
+    <td style="padding:15px">{base_path}/{version}/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllUsers(callback)</td>
+    <td style="padding:15px">Information on current account's users</td>
+    <td style="padding:15px">{base_path}/{version}/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscriptionById(subscriptionId, callback)</td>
+    <td style="padding:15px">Information on subscription identified by subscription Id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateSubscription(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Update an existing subscription by Id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteSubscriptionById(subscriptionId, callback)</td>
+    <td style="padding:15px">Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateActiveActiveVpcPeering(subscriptionId, peeringId, body, callback)</td>
+    <td style="padding:15px">Update an existing VPC peering in an existing active-active subscription.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteActiveActiveVpcPeering(subscriptionId, peeringId, callback)</td>
+    <td style="padding:15px">Delete a VPC peering from an existing active-active subscription.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateVpcPeering(subscriptionId, peeringId, body, callback)</td>
+    <td style="padding:15px">Update an existing VPC peering in an existing subscription.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteVpcPeering(subscriptionId, peeringId, callback)</td>
+    <td style="padding:15px">Deletes a VPC peering identified by an id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCidrWhiteList(subscriptionId, callback)</td>
+    <td style="padding:15px">Get CIDR  whitelist</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/cidr?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateSubscriptionCidrWhiteList(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Update subscription CIDR whitelist</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/cidr?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllSubscriptions(callback)</td>
+    <td style="padding:15px">Information on current account's subscriptions</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createSubscription(body, callback)</td>
+    <td style="padding:15px">Create a new subscription</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRegionsFromActiveActiveSubscription(subscriptionId, callback)</td>
+    <td style="padding:15px">Get all regions of an active-active subscription</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addNewRegionToActiveActiveSubscription(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Create a new region in an active-active subscription</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteRegionsFromActiveActiveSubscription(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Delete one or more regions from an active-active subscription</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getActiveActiveVpcPeerings(subscriptionId, callback)</td>
+    <td style="padding:15px">Get VPC peering details for an active-active subscription.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createActiveActiveVpcPeering(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Create a new VPC peering in an existing active-active subscription.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/regions/peerings?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getVpcPeering(subscriptionId, callback)</td>
+    <td style="padding:15px">Get VPC peering details. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createVpcPeering(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Create a new VPC peering in an existing subscription. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation.</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/peerings?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscriptionDatabaseByID(subscriptionId, databaseId, callback)</td>
+    <td style="padding:15px">Information on a specific database identified by subscription Id and database Id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateDatabase(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Update an existing database</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteDatabaseById(subscriptionId, databaseId, callback)</td>
+    <td style="padding:15px">Delete a specific database identified by subscription Id and database Id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateCrdbLocalProperties(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Update active-active local database properties</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/regions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscriptionDatabases(subscriptionId, offset, limit, callback)</td>
+    <td style="padding:15px">Information on databases belonging to subscription identified by subscription Id</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createDatabase(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Create a new database</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">importDatabase(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Import data from an RDB file or a different Redis database</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/import?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">backupDatabase(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Manually backup a database into the destination defined for it</td>
+    <td style="padding:15px">{base_path}/{version}/subscriptions/{pathv1}/databases/{pathv2}/backup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscriptionById1(subscriptionId, callback)</td>
+    <td style="padding:15px">Information on fixed subscription identified by subscription Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateSubscription1(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Update a fixed subscription</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteSubscriptionById1(subscriptionId, callback)</td>
+    <td style="padding:15px">Delete a fixed subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllSubscriptions1(callback)</td>
+    <td style="padding:15px">Information on current account's fixed subscriptions</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createSubscription1(body, callback)</td>
+    <td style="padding:15px">Create a new fixed subscription</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllFixedSubscriptionsPlans(provider, callback)</td>
+    <td style="padding:15px">Lookup list of plans</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/plans?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getFixedSubscriptionsPlanById(planId, callback)</td>
+    <td style="padding:15px">Information on a specific fixed subscription plan identified by plan Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/plans/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSubscriptionDatabaseByID1(subscriptionId, databaseId, callback)</td>
+    <td style="padding:15px">Information on a specific database identified by fixed subscription Id and database Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteFixedDatabaseByID(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Update a specific database identified by a fixed subscription Id and database Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteFixedDatabaseByID1(subscriptionId, databaseId, callback)</td>
+    <td style="padding:15px">Delete a specific database identified by a fixed subscription Id and database Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getFixedSubscriptionDatabases(subscriptionId, offset, limit, callback)</td>
+    <td style="padding:15px">Information on databases belonging to a fixed subscription identified by subscription Id</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createFixedDatabase(subscriptionId, body, callback)</td>
+    <td style="padding:15px">Create a new fixed database</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">importDatabase1(subscriptionId, databaseId, body, callback)</td>
+    <td style="padding:15px">Import data from an RDB file or a different Redis database</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}/import?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">backupDatabase1(subscriptionId, databaseId, callback)</td>
+    <td style="padding:15px">Manually backup a fixed database into the destination defined for it</td>
+    <td style="padding:15px">{base_path}/{version}/fixed/subscriptions/{pathv1}/databases/{pathv2}/backup?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCloudAccountById(cloudAccountId, callback)</td>
+    <td style="padding:15px">Information on a specific cloud account</td>
+    <td style="padding:15px">{base_path}/{version}/cloud-accounts/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateCloudAccount(cloudAccountId, body, callback)</td>
+    <td style="padding:15px">Update cloud account</td>
+    <td style="padding:15px">{base_path}/{version}/cloud-accounts/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteCloudAccount(cloudAccountId, callback)</td>
+    <td style="padding:15px">Delete specified cloud account</td>
+    <td style="padding:15px">{base_path}/{version}/cloud-accounts/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCloudAccounts(callback)</td>
+    <td style="padding:15px">List all configured cloud accounts</td>
+    <td style="padding:15px">{base_path}/{version}/cloud-accounts?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createCloudAccount(body, callback)</td>
+    <td style="padding:15px">Create cloud account</td>
+    <td style="padding:15px">{base_path}/{version}/cloud-accounts?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getUserByID(aclUserId, callback)</td>
+    <td style="padding:15px">Information on an ACL user identified by ACL user Id</td>
+    <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateUser1(aclUserId, body, callback)</td>
+    <td style="padding:15px">Update a new ACL user</td>
+    <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUser(aclUserId, callback)</td>
+    <td style="padding:15px">Delete an ACL user</td>
+    <td style="padding:15px">{base_path}/{version}/acl/users/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateRole(aclRoleId, body, callback)</td>
+    <td style="padding:15px">Update an ACL role</td>
+    <td style="padding:15px">{base_path}/{version}/acl/roles/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteAclRole(aclRoleId, callback)</td>
+    <td style="padding:15px">Delete an ACL role</td>
+    <td style="padding:15px">{base_path}/{version}/acl/roles/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateRedisRule(aclRedisRuleId, body, callback)</td>
+    <td style="padding:15px">Update an ACL redis rule</td>
+    <td style="padding:15px">{base_path}/{version}/acl/redisRules/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteRedisRule(aclRedisRuleId, callback)</td>
+    <td style="padding:15px">Delete an ACL redis rule</td>
+    <td style="padding:15px">{base_path}/{version}/acl/redisRules/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllUsers1(callback)</td>
+    <td style="padding:15px">Information on current account's ACL users</td>
+    <td style="padding:15px">{base_path}/{version}/acl/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createUser(body, callback)</td>
+    <td style="padding:15px">Create a new ACL user</td>
+    <td style="padding:15px">{base_path}/{version}/acl/users?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRoles(callback)</td>
+    <td style="padding:15px">Information on current account's ACL roles</td>
+    <td style="padding:15px">{base_path}/{version}/acl/roles?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createRole(body, callback)</td>
+    <td style="padding:15px">Create a new ACL role</td>
+    <td style="padding:15px">{base_path}/{version}/acl/roles?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllRedisRules(callback)</td>
+    <td style="padding:15px">Information on current account's ACL users</td>
+    <td style="padding:15px">{base_path}/{version}/acl/redisRules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createRedisRule(body, callback)</td>
+    <td style="padding:15px">Create a new ACL redis rule</td>
+    <td style="padding:15px">{base_path}/{version}/acl/redisRules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllTasks(callback)</td>
+    <td style="padding:15px">Currently active long running operations</td>
+    <td style="padding:15px">{base_path}/{version}/tasks?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getTaskById(taskId, callback)</td>
+    <td style="padding:15px">Get specific long running operation, identified by Task Id</td>
+    <td style="padding:15px">{base_path}/{version}/tasks/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSupportedRegions(provider, callback)</td>
+    <td style="padding:15px">Lookup list of regions for cloud provider</td>
+    <td style="padding:15px">{base_path}/{version}/regions?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAccountPaymentMethods(callback)</td>
+    <td style="padding:15px">Lookup list of current Account's payment methods</td>
+    <td style="padding:15px">{base_path}/{version}/payment-methods?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAccountSystemLogs(offset, limit, callback)</td>
+    <td style="padding:15px">System log information for current account</td>
+    <td style="padding:15px">{base_path}/{version}/logs?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSupportedDatabaseModules(callback)</td>
+    <td style="padding:15px">Lookup list of database modules supported in current account (support may differ based on subscription and database settings)</td>
+    <td style="padding:15px">{base_path}/{version}/database-modules?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDataPersistenceOptions(callback)</td>
+    <td style="padding:15px">Lookup list of data persistence values</td>
+    <td style="padding:15px">{base_path}/{version}/data-persistence?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">get(callback)</td>
+    <td style="padding:15px">Current account and related information</td>
+    <td style="padding:15px">{base_path}/{version}/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+
+## 0.1.1 [08-17-2023]
+
+* Bug fixes and performance improvements
+
+See commit c2e2675
+
+---
+

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>