@itentialopensource/adapter-thingspace 0.1.1

package/CALLS.md

@@ -0,0 +1,422 @@
+## 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 Thingspace. 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 Thingspace.</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 Thingspace. 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">getAccountUsingGET(aname, callback)</td>
+    <td style="padding:15px">Returns information about a specified account</td>
+    <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getServicesAndStatesUsingGET(aname, callback)</td>
+    <td style="padding:15px">Returns a list and details of all custom services and states defined for a specified account.</td>
+    <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/statesandservices?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getListUsingGET1(aname, next, callback)</td>
+    <td style="padding:15px">When HTTP status is 202, a URL will be returned in the Location header of the form /leads/{aname}?next={token}. This URL can be used to request the next set of leads.</td>
+    <td style="padding:15px">{base_path}/{version}/leads/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getRequestStatusUsingGET(aname, requestId, callback)</td>
+    <td style="padding:15px">Returns the current status of an asynchronous request that was made for a single device.</td>
+    <td style="padding:15px">{base_path}/{version}/accounts/{pathv1}/requests/{pathv2}/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">listCallbacksUsingGET(aname, callback)</td>
+    <td style="padding:15px">Returns the name and endpoint URL of all callback listening services registered for a given account.</td>
+    <td style="padding:15px">{base_path}/{version}/callbacks/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">registerCallbackUsingPOST(aname, body, callback)</td>
+    <td style="padding:15px">You are responsible for creating and running a listening process on your server at that URL.</td>
+    <td style="padding:15px">{base_path}/{version}/callbacks/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">unregisterCallbackUsingDELETE(aname, sname, callback)</td>
+    <td style="padding:15px">Stops the platform from sending callback messages for the specified account and service.</td>
+    <td style="padding:15px">{base_path}/{version}/callbacks/{pathv1}/name/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">activeUsingPOST(body, callback)</td>
+    <td style="padding:15px">If the devices do not already exist in the account, this API resource adds them before activation.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/activate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addUsingPOST(body, callback)</td>
+    <td style="padding:15px">Use this API if you want to manage some device settings before you are ready to activate service for the devices.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/add?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateContactInfoUsingPUT(body, callback)</td>
+    <td style="padding:15px">Sends a CarrierService callback message for each device in the request when the contact information has been changed, or if there was a problem and the change could not be completed.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/contactinfo?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateCustomFieldsUsingPUT(body, callback)</td>
+    <td style="padding:15px">Sends a CarrierService callback message for each device in the request when the custom fields have been changed, or if there was a problem and the change could not be completed.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/customFields?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deactiveUsingPOST(body, callback)</td>
+    <td style="padding:15px">Deactivating service for a device may result in an early termination fee (ETF) being charged to the account, depending on the terms of the contract with Verizon. If your contract allows ETF waivers and if you want to use one for a particular deactivation, set the etfWaiver value to True.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/deactivate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteUsingPOST(body, callback)</td>
+    <td style="padding:15px">Use this API to remove unneeded devices from an account</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/delete?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">listUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns information about a specified device or a list of devices in an account.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">imeiIccidMismatchListUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns a list of all 4G devices with an ICCID  that was not activated with the expected IMEI.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/list/imeiiccidmismatch?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">moveUsingPut(body, callback)</td>
+    <td style="padding:15px">Move active devices from one billing account to another within a customer profile.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/move?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">gotostateUsingPut(body, callback)</td>
+    <td style="padding:15px">Changes the provisioning state of one or more devices to a specified customer-defined service and state.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/gotostate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateServicePlanUsingPUT(body, callback)</td>
+    <td style="padding:15px">Sets a new service plan for one or more devices.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/plan?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">suspendUsingPOST(body, callback)</td>
+    <td style="padding:15px">Suspends service for one or more devices.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/suspend?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">restoreUsingPOST(body, callback)</td>
+    <td style="padding:15px">Restore service to one or more suspended devices.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/actions/restore?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deviceAvailabilityListUsingPOST(body, callback)</td>
+    <td style="padding:15px">Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/availability/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">connectionListHistoryUsingPOST(body, callback)</td>
+    <td style="padding:15px">Each response includes a maximum of 500 records. To obtain more records, you can call the API multiple times, adjusting the earliest value each time to start where the previous request finished.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/connections/actions/listHistory?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">changeCostCenterUsingPUT(body, callback)</td>
+    <td style="padding:15px">Changes or removes the costCenterCode value for one or more devices.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/costCenter?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getExtendedDiagsUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns basic diagnostic information about a specified device, including connectivity, provisioning, and billing status.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/extendeddiagnostics/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">provisioningHistoryListUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns the provisioning history of a device during a specified time period.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/history/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">prlListUsingPOST(body, callback)</td>
+    <td style="padding:15px">4G and GSM devices do not have a PRL.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/prl/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceSuspensionStatusUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns DeviceSuspensionStatus callback messages containing the current device state and information on how many days a device has been suspended and can continue to be suspended.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/suspension/status?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">usageListUsingPOST(body, callback)</td>
+    <td style="padding:15px">Returns the network data usage history of a device during a specified time period.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/usage/actions/list?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">aggregateUsingPOST(body, callback)</td>
+    <td style="padding:15px">The information is returned in a callback response, so you must register a URL for DeviceUsage callback messages using the POST /callbacks API.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/usage/actions/list/aggregate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">changeDeviceIdUsingPUT(serviceType, body, callback)</td>
+    <td style="padding:15px">Changes the identifier of a 3G or 4G device to match hardware changes made for a line of service.</td>
+    <td style="padding:15px">{base_path}/{version}/devices/{pathv1}/actions/deviceId?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createDeviceGroupUsingPOST(body, callback)</td>
+    <td style="padding:15px">Creates a new device group and optionally adds a set of devices to that group.</td>
+    <td style="padding:15px">{base_path}/{version}/groups?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getListUsingGET(aname, callback)</td>
+    <td style="padding:15px">Returns a list of device groups in an account</td>
+    <td style="padding:15px">{base_path}/{version}/groups/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDeviceGroupInfoUsingGET(aname, gname, next, callback)</td>
+    <td style="padding:15px">When HTTP status is 202, a URL will be returned in the Location header of the form /groups/{aname}/name/{gname}/?next={token}. This URL can be used to request the next set of groups.</td>
+    <td style="padding:15px">{base_path}/{version}/groups/{pathv1}/name/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateDeviceGroupUsingPUT(aname, gname, body, callback)</td>
+    <td style="padding:15px">Make changes to a device group, including changing the name and description, and adding or removing devices.</td>
+    <td style="padding:15px">{base_path}/{version}/groups/{pathv1}/name/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteDeviceGroupUsingDELETE(aname, gname, callback)</td>
+    <td style="padding:15px">Deletes a device group. Devices in the group are moved to the default device group and are not deleted from the account.</td>
+    <td style="padding:15px">{base_path}/{version}/groups/{pathv1}/name/{pathv2}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getServicePlanListUsingGET(aname, callback)</td>
+    <td style="padding:15px">Returns a list of all data service plans that are associated with a specified account.</td>
+    <td style="padding:15px">{base_path}/{version}/plans/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">loginUsingPOST(body, callback)</td>
+    <td style="padding:15px">Initiates a Connectivity Management session and returns a session token required in subsequent API requests.</td>
+    <td style="padding:15px">{base_path}/{version}/session/login?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">logoutUsingPOST(callback)</td>
+    <td style="padding:15px">Ends a Connectivity Management session.</td>
+    <td style="padding:15px">{base_path}/{version}/session/logout?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">resetUsingPUT(body, callback)</td>
+    <td style="padding:15px">The new password is effective immediately. Passwords do not expire, but Verizon recommends changing your password every 90 days.</td>
+    <td style="padding:15px">{base_path}/{version}/session/password/actions/reset?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">sendSmsMessageUsingPOST(body, callback)</td>
+    <td style="padding:15px">The messages are queued on the ThingSpace Platform and sent as soon as possible, but they may be delayed due to traffic and routing considerations.</td>
+    <td style="padding:15px">{base_path}/{version}/sms?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSmsMessagesUsingGET(aname, next, callback)</td>
+    <td style="padding:15px">When HTTP status is 202, a URL will be returned in the Location header of the form /sms/{aname}/history?next={token}. This URL can be used to request the next set of messages.</td>
+    <td style="padding:15px">{base_path}/{version}/sms/{pathv1}/history?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">startSmsCallbackUsingPUT(aname, callback)</td>
+    <td style="padding:15px">Starts delivery of queued SMS messages for the specific account.</td>
+    <td style="padding:15px">{base_path}/{version}/sms/{pathv1}/startCallbacks?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+
+## 0.1.1 [02-02-2023]
+
+* Bug fixes and performance improvements
+
+See commit 4d71468
+
+---
+

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>