@itentialopensource/adapter-alkira 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.3.1 [09-12-2023]
+
+* more migration & metadata changes
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!7
+
+---
+
 ## 0.3.0 [08-16-2023]
 
 * Minor/2023 migration

package/README.md

@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.

package/adapterBase.js

@@ -1027,6 +1027,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
   }
 
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntitiesAuth
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntitiesAuth(entityType, entityList, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliance that match the deviceName
    *
@@ -1043,6 +1061,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevice(deviceName, callback);
   }
 
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDeviceAuth
+   * @param {String} deviceName - the deviceName to find (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDeviceAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDeviceAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Get Appliances that match the filter
    *
@@ -1059,6 +1094,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getDevicesFiltered(options, callback);
   }
 
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFilteredAuth
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFilteredAuth(options, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
+  }
+
   /**
    * @summary Gets the status for the provided appliance
    *
@@ -1075,6 +1127,23 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.isAlive(deviceName, callback);
   }
 
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAliveAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAliveAuth) or the error
+   */
+  isAliveAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-isAliveAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
+  }
+
   /**
    * @summary Gets a config for the provided Appliance
    *
@@ -1092,6 +1161,24 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.getConfig(deviceName, format, callback);
   }
 
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfigAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfigAuth(deviceName, format, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getConfigAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
+  }
+
   /**
    * @summary Gets the device count from the system
    *
@@ -1107,6 +1194,22 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.iapGetDeviceCount(callback);
   }
 
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCountAuth
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCountAuth(callOptions, callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
+  }
+
   /* ********************************************** */
   /*                                                */
   /*          EXPOSES GENERIC HANDLER               */

package/metadata.json

@@ -1,5 +1,6 @@
 {
   "name": "adapter-alkira",
+  "webName": "Adapter for Integration to Alkira Cloud Management",
   "vendor": "Alkira",
   "product": "Cloud Management",
   "osVersion": [],
@@ -12,13 +13,17 @@
     "2022.1.x",
     "2023.1.x"
   ],
-  "method": "REST API",
+  "method": "REST",
   "type": "Adapter",
-  "example": "",
   "domains": [
     "Cloud"
   ],
-  "tags": [],
+  "tags": [
+    "Cloud Networking"
+  ],
+  "useCases": [
+    "Create Hybrid Cloud Connections"
+  ],
   "deprecated": {
     "isDeprecated": false
   },
@@ -28,6 +33,11 @@
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-alkira",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-alkira",
     "docLink": "https://docs.itential.com/opensource/docs/alkira",
+    "demoLinks": [
+      "https://www.itential.com/resource/demo/itential-alkira-simplify-automate-to-optimize-multi-cloud-networks/",
+      "https://www.itential.com/blog/company/news-events/itential-alkira-integrate-to-simplify-automate-multi-cloud-networking/",
+      "https://www.itential.com/search/?_sf_s=alkira"
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
@@ -36,66 +46,26 @@
     "productLink": "https://www.alkira.com/",
     "apiLinks": []
   },
+  "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "automations": [
+    "workflowProjects": [
       {
         "name": "Alkira - Cloud Network as a Service",
-        "overview": "Project for use cases around Alkira Cloud Network such as: Create AWS VPC Connector - Alkira, Create Azure VNet Connector - Alkira, Create Internet Connector - Alkira, Create IPSec Connector - Alkira, Get ID for Segment - Alkira, Provision Palo Alto Firewall - Alkira",
+        "webName": "Alkira - Cloud Network as a Service",
+        "overview": "Project for use cases around Alkira Cloud Network as a Service using REST protocol.",
+        "isDependency": false,
         "versions": [
-          "^1.0.0"
+          "^1.0.2"
         ],
         "repoLink": "https://gitlab.com/itentialopensource/pre-built-automations/alkira-cloud-network-as-a-service",
-        "docLink": "<TBD>",
-        "webLink": "<TBD>"
+        "docLink": "",
+        "webLink": ""
       }
     ],
-    "transformations": [],
-    "useCases": [
-      {
-        "name": "Create AWS VPC Connector - Alkira",
-        "overview": "Creates AWS VPC connector over Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"vpcId\": \"vpc-05cbeb1e27dbba348\",\n  \"credentialId\": \"48ebf9a7-1af8-45a4-9569-7adcc100e130\",\n  \"vpcOwnerId\": \"462676810652\",\n  \"connectorName\": \"ConnectorTest1\",\n  \"cxp\": \"US-EAST-1\",\n  \"customerRegion\": \"us-west-1\",\n  \"customerName\": \"Customer\",\n  \"size\": \"SMALL\",\n  \"group\": \"PROD-AWS\",\n  \"segmentName\": \"CORP\",\n  \"tenantNetworkId\": 170,\n  \"enabled\": true,\n  \"directInterVPCCommunicationEnabled\": false\n}",
-        "exampleOutput": "{\n  \"createdAWSVPCConnectorResult\": {\n    \"icode\": \"AD.201\",\n    \"response\": {\n      \"id\": 11374,\n      \"name\": \"ConnectorTest2\",\n      \"cxp\": \"US-EAST\",\n      \"segments\": [\n        \"CORP\"\n      ],\n      \"vpcId\": \"vpc-0af55e16b6e371902\",\n      \"vpcOwnerId\": \"462676810652\",\n      \"customerName\": \"Customer\",\n      \"customerRegion\": \"us-east-1\",\n      \"credentialId\": \"48ebf9a7-1af8-45a4-9569-7adcc100e130\",\n      \"group\": \"PROD-AWS\",\n      \"groupId\": 16766,\n      \"implicitGroupId\": 23386,\n      \"billingTags\": [],\n      \"size\": \"SMALL\",\n      \"vpcRouting\": {\n        \"exportToCXPOptions\": {\n          \"userInputPrefixes\": [\n            {\n              \"id\": null,\n              \"value\": \"10.0.0.0/24\",\n              \"type\": \"CIDR\"\n            }\n          ],\n          \"routeExportMode\": \"USER_INPUT_PREFIXES\",\n          \"selectedCidrPrefixes\": [\n            \"10.0.0.0/24\"\n          ],\n          \"selectedSubnetPrefixes\": [],\n          \"selectedSubnetIds\": []\n        },\n        \"importFromCXPOptions\": {\n          \"routeTables\": [\n            {\n              \"id\": \"rtb-0d4d1c975c3f30312\",\n              \"prefixListIds\": [],\n              \"routeImportMode\": \"ADVERTISE_DEFAULT_ROUTE\"\n            }\n          ]\n        }\n      },\n      \"enabled\": true,\n      \"primary\": true,\n      \"directInterVPCCommunicationEnabled\": false,\n      \"configStatus\": {\n        \"configValid\": true,\n        \"messages\": []\n      }\n    }\n  }\n}"
-      },
-      {
-        "name": "Create Azure VNet Connector - Alkira",
-        "overview": "Creates Azure VNet connector over Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"segmentName\": \"CORP\",\n  \"credentialId\": \"a39a474b-34f4-41b3-b684-95fd6024b2a9\",\n  \"connectorName\": \"TestAzure2\",\n  \"cxp\": \"US-EAST\",\n  \"customerRegion\": \"westus\",\n  \"size\": \"SMALL\",\n  \"vnetId\": \"/subscriptions/34211a125-c6e3-2015-bc4e-84dbb14128f9/resourceGroups/itential-poc-resourcegroup/providers/Microsoft.Network/virtualNetworks/itential-poc-vnet1\",\n  \"resourceGroupName\": \"itential-poc-resourcegroup\",\n  \"subscriptionId\": \"34211a125-c6e3-2015-bc4e-84dbb14128f9\",\n  \"group\": \"PROD_AZURE\",\n  \"tenantNetworkId\": 170,\n  \"enabled\": true\n}",
-        "exampleOutput": "{\n  \"createdAzureVNETConnectorResult\": {\n    \"icode\": \"AD.201\",\n    \"response\": {\n      \"id\": 11378,\n      \"gatewaySubnetPrefix\": \"10.12.1.0/27\",\n      \"name\": \"TestAzure2\",\n      \"group\": \"PROD_AZURE\",\n      \"groupId\": 17663,\n      \"implicitGroupId\": 23390,\n      \"vnetId\": \"/subscriptions/34211a125-c6e3-2015-bc4e-84dbb14128f9/resourceGroups/itential-poc-resourcegroup/providers/Microsoft.Network/virtualNetworks/itential-poc-vnet1\",\n      \"cxp\": \"US-EAST\",\n      \"customerRegion\": \"westus\",\n      \"credentialId\": \"a39a474b-34f4-41b3-b684-95fd6024b2a9\",\n      \"resourceGroupName\": \"itential-poc-resourcegroup\",\n      \"enabled\": true,\n      \"primary\": true,\n      \"deploymentMode\": \"VGW\",\n      \"connectionMode\": \"VNET_GATEWAY\",\n      \"segments\": [\n        \"CORP\"\n      ],\n      \"billingTags\": [],\n      \"size\": \"SMALL\",\n      \"vnetRouting\": {\n        \"exportToCXPOptions\": {\n          \"userInputPrefixes\": null\n        },\n        \"importFromCXPOptions\": {\n          \"prefixListIds\": [],\n          \"routeImportMode\": \"ADVERTISE_DEFAULT_ROUTE\",\n          \"cidrs\": null,\n          \"subnets\": null\n        },\n        \"serviceRoutes\": {\n          \"cidrs\": null,\n          \"subnets\": null\n        }\n      },\n      \"subscriptionId\": \"34211a125-c6e3-2015-bc4e-84dbb14128f9\",\n      \"configStatus\": {\n        \"configValid\": true,\n        \"messages\": []\n      },\n      \"vgwdeployment\": true\n    }\n  }\n}"
-      },
-      {
-        "name": "Create Internet Connector - Alkira",
-        "overview": "Creates Internet connector over Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"tenantNetworkId\": 170,\n  \"cxp\": \"US-EAST\",\n  \"connectorName\": \"TestConnectorName2\",\n  \"segment\": \"CORP\",\n  \"description\": \"Internet Connector\",\n  \"group\": \"inet-zone\",\n  \"algorithm\": \"HASHING\",\n  \"keys\": \"DEFAULT\"\n}",
-        "exampleOutput": "{\n  \"createdInternetConnectorResult\": {\n    \"icode\": \"AD.201\",\n    \"response\": {\n      \"id\": 11375,\n      \"name\": \"TestConnectorName2\",\n      \"description\": \"Internet Connector\",\n      \"group\": \"inet-zone\",\n      \"groupId\": 20501,\n      \"implicitGroupId\": 23387,\n      \"cxp\": \"US-EAST\",\n      \"segments\": [\n        \"CORP\"\n      ],\n      \"billingTags\": [],\n      \"size\": \"SMALL\",\n      \"trafficDistribution\": {\n        \"algorithm\": \"HASHING\",\n        \"algorithmAttributes\": {\n          \"keys\": \"DEFAULT\"\n        }\n      },\n      \"numOfPublicIPs\": 2,\n      \"enabled\": true\n    }\n  }\n}"
-      },
-      {
-        "name": "Create IPSec Connector - Alkira",
-        "overview": "Creates IPSec connector over Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"cxp\": \"US-EAST\",\n  \"connectorName\": \"TestConnectorName\",\n  \"siteName\": \"TestConnectorName-1\",\n  \"customerGwIp\": \"10.20.30.40\",\n  \"presharedKeys\": [\"abc\",\"xyz\"],\n  \"size\": \"SMALL\",\n  \"segmentName\": \"CORP\",\n  \"segmentId\": 2878,\n  \"tenantNetworkId\": 170\n}",
-        "exampleOutput": "{\n  \"createdIPSecConnectorResult\": {\n    \"icode\": \"AD.201\",\n    \"response\": {\n      \"id\": 11377,\n      \"name\": \"TestConnectorName1\",\n      \"segments\": [\n        \"CORP\"\n      ],\n      \"segmentOptions\": {\n        \"CORP\": {\n          \"segmentId\": 2878,\n          \"disableInternetExit\": true,\n          \"advertiseOnPremRoutes\": false\n        }\n      },\n      \"cxp\": \"US-EAST\",\n      \"group\": \"OnPrem\",\n      \"groupId\": 20028,\n      \"implicitGroupId\": 23389,\n      \"size\": \"SMALL\",\n      \"sites\": [\n        {\n          \"id\": 3131,\n          \"name\": \"TestConnectorName-1\",\n          \"connectorId\": 11377,\n          \"gatewayIpType\": \"STATIC\",\n          \"gatewayNo\": 0,\n          \"customerGwIp\": \"10.20.30.40\",\n          \"presharedKeys\": [\n            \"abc\",\n            \"xyz\"\n          ],\n          \"state\": \"PENDING\",\n          \"billingTags\": [],\n          \"enableTunnelRedundancy\": true,\n          \"haMode\": \"ACTIVE\",\n          \"remoteAuthValueKey\": \"STATIC--\"\n        }\n      ],\n      \"state\": \"PENDING\",\n      \"type\": \"IP_SEC\",\n      \"vpnMode\": \"ROUTE_BASED\",\n      \"routingOptions\": {\n        \"staticRouting\": null,\n        \"dynamicRouting\": {\n          \"customerGwAsn\": \"65000\",\n          \"bgpAuthKeyAlkira\": null,\n          \"availability\": \"IPSEC_INTERFACE_PING\"\n        }\n      },\n      \"enabled\": true,\n      \"primary\": true,\n      \"secondaryCXPs\": []\n    }\n  }\n}"
-      },
-      {
-        "name": "Get ID for Segment - Alkira",
-        "overview": "Get ID for segment in Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"segmentName\": \"CORP\",\n  \"tenantNetworkId\": 170\n}",
-        "exampleOutput": "2878"
-      },
-      {
-        "name": "Provision Palo Alto Firewall - Alkira",
-        "overview": "Provisions Palo Alto Firewall over Alkira Cloud Network as a Service.",
-        "webLink": "",
-        "exampleInput": "{\n  \"adapterId\": \"alkira\",\n  \"tenantNetworkId\": 170,\n  \"username\": \"username\",\n  \"password\": \"password\",\n  \"name\": \"Firewall500\",\n  \"cxp\": \"US-EAST\",\n  \"version\": \"9.1.3\",\n  \"segmentId\": 2878,\n  \"segmentName\": \"CORP\",\n  \"registrationPinValue\": \"2abfbad825a4233b8d1e243a07925a2c\",\n  \"registrationPinId\": \"a52685ac-1fb8-4a90-b891-18cf9b461237\",\n  \"expires\": \"Wed Aug 09 2023\",\n  \"panoramaEnabled\": false,\n  \"size\": \"SMALL\",\n  \"licenseType\": \"PAY_AS_YOU_GO\",\n  \"bundle\": \"VM_SERIES_BUNDLE_1\",\n  \"maxInstanceCount\": 1,\n  \"minInstanceCount\": 1,\n  \"tunnelProtocol\": \"IPSEC\",\n  \"globalProtectEnabled\": false,\n  \"onPremZone\": [\"OnPrem\"],\n  \"prodAwsZone\": [\"PROD-AWS\"],\n  \"prodAzureZone\": [\"PROD_AZURE\"],\n  \"inetZone\": [\"INET-Connector\"]\n}",
-        "exampleOutput": "{\n  \"panFW\": {\n    \"icode\": \"AD.201\",\n    \"response\": {\n      \"id\": 1527,\n      \"name\": \"Firewall500\",\n      \"cxp\": \"US-EAST\",\n      \"segments\": [\n        2878\n      ],\n      \"panoramaEnabled\": false,\n      \"managementSegment\": 2878,\n      \"maxInstanceCount\": 1,\n      \"minInstanceCount\": 1,\n      \"licenseType\": \"PAY_AS_YOU_GO\",\n      \"version\": \"9.1.3\",\n      \"credentialId\": \"40a6186d-e691-4a81-8e1f-f4a43416af12\",\n      \"instances\": [\n        {\n          \"id\": 1934,\n          \"uniqueId\": \"c3d08fd9-2add-466b-af9c-c1cdabeb56aa\",\n          \"name\": \"Firewall500\",\n          \"credentialId\": \"96af7b91-426e-4c0e-b427-6cfa3402c846\",\n          \"dormant\": false,\n          \"hostName\": \"Firewall500\",\n          \"masterKeyEnabled\": false,\n          \"internalName\": \"svci-pan-afae0629-23fa-4f0a-85e7-432f6cc4\"\n        }\n      ],\n      \"size\": \"SMALL\",\n      \"segmentOptions\": {\n        \"CORP\": {\n          \"segmentId\": 2878,\n          \"zonesToGroups\": {\n            \"on-prem-zone\": [\n              \"OnPrem\"\n            ],\n            \"ALKIRA_MGMT_ZONE\": [],\n            \"prod-aws-zone\": [\n              \"PROD-AWS\"\n            ],\n            \"prod-azure-zone\": [\n              \"PROD_AZURE\"\n            ],\n            \"inet-zone\": [\n              \"INET-Connector\"\n            ]\n          }\n        }\n      },\n      \"billingTags\": [],\n      \"tunnelProtocol\": \"IPSEC\",\n      \"panWarmBootEnabled\": false,\n      \"bundle\": \"VM_SERIES_BUNDLE_1\",\n      \"globalProtectEnabled\": false,\n      \"masterKeyEnabled\": false,\n      \"registrationCredentialId\": \"a52685ac-1fb8-4a90-b891-18cf9b461237\",\n      \"internalName\": \"svc-pan-14af6dba-bd57-4351-a322-fc13d784\",\n      \"panSubLicenseType\": \"MODEL_BASED\"\n    }\n  }\n}"
-      }
-    ]
+    "transformationProjects": [],
+    "exampleProjects": []
   }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-alkira",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "This adapter integrates with system described as: alkiraApi.",
   "main": "adapter.js",
   "systemName": "Alkira",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.5",
+  "engineVersion": "1.67.8",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,12 +54,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-alkira#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.0",
+    "@itentialopensource/adapter-utils": "^5.1.7",
+    "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
-    "esprima": "^4.0.1",
     "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
     "mocha": "^10.2.0",

package/propertiesSchema.json

@@ -1063,6 +1063,38 @@
                 "description": "The method of the call to getDevicesFiltered",
                 "default": "GET"
               },
+              "pagination": {
+                "type": "object",
+                "description": "todo",
+                "properties": {
+                  "offsetVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines how to go to next set of results"
+                  },
+                  "limitVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines the max results returned in a request"
+                  },
+                  "incrementBy": {
+                    "type": "string",
+                    "enum": [
+                      "limit",
+                      "page"
+                    ],
+                    "description": "How to incremenet offset. Default limit",
+                    "default": "limit"
+                  },
+                  "requestLocation": {
+                    "type": "string",
+                    "enum": [
+                      "query",
+                      "body"
+                    ],
+                    "description": "Where in request the pagination data goes",
+                    "default": "query"
+                  }
+                }
+              },
               "query": {
                 "type": "object",
                 "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1487,6 +1519,38 @@
                       "description": "The method of the call to getDevice",
                       "default": "GET"
                     },
+                    "pagination": {
+                      "type": "object",
+                      "description": "todo",
+                      "properties": {
+                        "offsetVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines how to go to next set of results"
+                        },
+                        "limitVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines the max results returned in a request"
+                        },
+                        "incrementBy": {
+                          "type": "string",
+                          "enum": [
+                            "limit",
+                            "page"
+                          ],
+                          "description": "How to incremenet offset. Default limit",
+                          "default": "limit"
+                        },
+                        "requestLocation": {
+                          "type": "string",
+                          "enum": [
+                            "query",
+                            "body"
+                          ],
+                          "description": "Where in request the pagination data goes",
+                          "default": "query"
+                        }
+                      }
+                    },
                     "query": {
                       "type": "object",
                       "description": "The json object with query parameters of the call to getDevice",