@itentialopensource/adapter-selector_ai 0.1.1

package/CALLS.md

@@ -0,0 +1,405 @@
+## 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 Itential Platform 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 Selector_ai. 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 Selector_ai.</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 Itential Platform - includes actions, schema, mockdata and other configurations.</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">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">iapTroubleshootAdapter(props, 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(maxCalls, callback)</td>
+    <td style="padding:15px">This call will return the results of running basic get API calls. By default 5 get calls without parameters will be run. You can ask for more or less by setting maxCalls.</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 Itential Platform Database.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
+    <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</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">iapRunAdapterLint(callback)</td>
+    <td style="padding:15px">Runs lint on the adapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterTests(callback)</td>
+    <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetAdapterInventory(callback)</td>
+    <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+
+### Adapter Cache Calls
+
+These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
+
+<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">iapPopulateEntityCache(entityTypes, callback)</td>
+    <td style="padding:15px">This call populates the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
+    <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+
+### Adapter Broker Calls
+
+These are adapter methods that are used to integrate to Itential Platform 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 Itential Platform 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">No</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">No</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">No</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">No</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">No</td>
+  </tr>
+</table>
+<br>
+
+
+### Specific Adapter Calls
+
+Specific adapter calls are built based on the API of the Selector_ai. 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">getAllInventoryV1InventoryGet(iapMetadata, callback)</td>
+    <td style="padding:15px">Get_all_inventory_v1_inventory_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryCreationV1InventoryPost(body, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_creation_v1_inventory_post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryUpdateV1InventoryNamePut(name, body, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_update_v1_inventory__name__put</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deletingSpecificInventoryV1InventoryNameDelete(name, iapMetadata, callback)</td>
+    <td style="padding:15px">Deleting_Specific_Inventory_v1_inventory__name__delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemGetV1InventoryNameGet(name, pattern, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_get_v1_inventory__name__get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemGetV1InventoryNameIdGet(name, id, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_get_v1_inventory__name___id__get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemCreationV1InventoryNamePost(name, body, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_creation_v1_inventory__name__post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemCreationV1InventoryNameIdPut(name, id, body, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_creation_v1_inventory__name___id__put</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemDeletionV1InventoryNameIdDelete(name, id, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_deletion_v1_inventory__name___id__delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/{pathv1}/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemCreationV1InventoryBulkNamePost(name, merge, body, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_creation_v1_inventory_bulk__name__post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/bulk/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemCreationV1InventoryCsvNamePost(name, merge, file, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_creation_v1_inventory_csv__name__post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory/csv/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">inventoryItemGetV1InventoryItemsGet(type, iapMetadata, callback)</td>
+    <td style="padding:15px">Inventory_Item_get_v1_inventory_items_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-items?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllInventoryV1InventorySchemaGet(iapMetadata, callback)</td>
+    <td style="padding:15px">Get_all_inventory_v1_inventory_schema_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">postInventoryV1InventorySchema(file, iapMetadata, callback)</td>
+    <td style="padding:15px">Post_inventory_v1_inventory_schema</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putInventoryV1InventorySchema(file, iapMetadata, callback)</td>
+    <td style="padding:15px">Put_inventory_v1_inventory_schema</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">processinventoryschemadelete(iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteProcessinventoryschemadelete(type, iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getsAllInventoryschema(iapMetadata, callback)</td>
+    <td style="padding:15px">Gets All Inventory schema</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v2/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">processinventoryschemaJSONinput(body, iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema JSON input</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v2/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteProcessinventoryschemadelete1(iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v2/inventory-schema?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">putProcessinventoryschemaJSONinput(type, body, iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema JSON input</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v2/inventory-schema/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteProcessinventoryschemadelete2(type, iapMetadata, callback)</td>
+    <td style="padding:15px">Process inventory schema delete</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v2/inventory-schema/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">porcessuploadJSONfile(encodeType = 'json', file, iapMetadata, callback)</td>
+    <td style="padding:15px">Porcess upload JSON file</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema-files/import?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">downloadinventoryschemaJSONfile(encodeType = 'json', body, iapMetadata, callback)</td>
+    <td style="padding:15px">Download inventory schema JSON file</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-schema-files/export?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">handleInventoryFilesPostInventoryFilesImportPost(encodeType, zipFile, iapMetadata, callback)</td>
+    <td style="padding:15px">handle_inventory_files_post_inventory_files_import_post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-files/import?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">handleInventoryFilesGetInventoryFilesExportPost(encodeType, body, iapMetadata, callback)</td>
+    <td style="padding:15px">handle_inventory_files_get_inventory_files_export_post</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-files/export?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">handleInventoryCsvFileGet(name, iapMetadata, callback)</td>
+    <td style="padding:15px">handle_inventory_csv_file_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/v1/inventory-file/csv/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">get(iapMetadata, callback)</td>
+    <td style="padding:15px">home_page__get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getOpstats(iapMetadata, callback)</td>
+    <td style="padding:15px">opstats_opstats_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/opstats?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getVersion(iapMetadata, callback)</td>
+    <td style="padding:15px">version_version_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/version?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAIConfig(iapMetadata, callback)</td>
+    <td style="padding:15px">config_config_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/config?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getHealth(iapMetadata, callback)</td>
+    <td style="padding:15px">health_health_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/health?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">healthLogsGet(iapMetadata, callback)</td>
+    <td style="padding:15px">health_logs_get</td>
+    <td style="padding:15px">{base_path}/{version}/inventory_manager/logs?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>

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>

package/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of rules for contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
+
+## How to Contribute
+
+Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

package/ENHANCE.md

@@ -0,0 +1,69 @@
+## Enhancements
+
+### Adding a Second Instance of an Adapter
+
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the Itential Platform Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+
+### Adding Adapter Calls
+
+There are multiple ways to add calls to an existing adapter.
+
+The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute `npm run adapter:update`.
+
+```bash
+mv updatePackage.zip adapter-selector_ai
+cd adapter-selector_ai
+npm run adapter:update
+```
+
+If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
+
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in Itential Platform, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
+
+```text
+Files to update
+* entities/<entity>/action.json: add an action
+* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
+* adapter.js: add the new method and make sure it calls the proper entity and action
+* pronghorn.json: add the new method
+* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
+* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
+```
+
+### Adding Adapter Properties
+
+While changing adapter properties is done in the service instance configuration section of Itential Platform, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+
+```text
+Files to update
+* propertiesSchema.json: add the new property and how it is defined
+* sampleProperties: add the new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Changing Adapter Authentication
+
+Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
+
+```text
+Files to update
+* entities/.system/action.json: change the getToken action as needed
+* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
+* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
+* propertiesSchema.json: add any new property and how it is defined
+* sampleProperties: add any new property with a default value
+* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
+* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
+```
+
+### Enhancing Adapter Integration Tests
+
+The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
+
+```text
+Files to update
+* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
+```
+
+As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.