@itentialopensource/adapter-calix_support_cloud 0.1.1

package/pronghorn.json

@@ -0,0 +1,1780 @@
+{
+  "id": "@itentialopensource/adapter-calix_support_cloud",
+  "type": "Adapter",
+  "export": "CalixSupportCloud",
+  "title": "Calix_support_cloud",
+  "src": "adapter.js",
+  "roles": [
+    "admin"
+  ],
+  "methods": [
+    {
+      "name": "iapUpdateAdapterConfiguration",
+      "summary": "Updates the adapter configuration",
+      "description": "Updates the adapter configuration file with the provided changes",
+      "input": [
+        {
+          "name": "configFile",
+          "type": "string",
+          "info": "The name of the file to change",
+          "required": true,
+          "schema": {
+            "title": "configFile",
+            "type": "string"
+          }
+        },
+        {
+          "name": "changes",
+          "type": "object",
+          "info": "JSON object containing the configuration changes",
+          "required": true,
+          "schema": {
+            "title": "changes",
+            "type": "object"
+          }
+        },
+        {
+          "name": "entity",
+          "type": "string",
+          "info": "The entity in which the changes are being made",
+          "required": false,
+          "schema": {
+            "title": "entity",
+            "type": "string"
+          }
+        },
+        {
+          "name": "type",
+          "type": "string",
+          "info": "The type of file to change - action, schema, or mock",
+          "required": false,
+          "schema": {
+            "title": "type",
+            "type": "string"
+          }
+        },
+        {
+          "name": "action",
+          "type": "string",
+          "info": "The action to be changed",
+          "required": false,
+          "schema": {
+            "title": "action",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUpdateAdapterConfiguration"
+      },
+      "task": true
+    },
+    {
+      "name": "iapFindAdapterPath",
+      "summary": "Provides the ability to see if a particular API path is supported by the adapter",
+      "description": "Provides the ability to see if a particular API path is supported by the adapter",
+      "input": [
+        {
+          "name": "apiPath",
+          "type": "string",
+          "info": "The API Path you want to check - make sure to not include base path and version",
+          "description": "The API Path you want to check - make sure to not include base path and version",
+          "schema": {
+            "title": "apiPath",
+            "type": "string"
+          },
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapFindAdapterPath"
+      },
+      "task": true
+    },
+    {
+      "name": "iapSuspendAdapter",
+      "summary": "Suspends the adapter",
+      "description": "Suspends the adapter",
+      "input": [
+        {
+          "name": "mode",
+          "type": "enum",
+          "enumerals": [
+            "pause",
+            "error"
+          ],
+          "info": "How incoming requests are handled. Defaults to 'pause'",
+          "description": "How incoming requests are handled. Defaults to 'pause'",
+          "schema": {
+            "title": "mode",
+            "type": "string"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapSuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapUnsuspendAdapter",
+      "summary": "Unsuspends the adapter",
+      "description": "Unsuspends the adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter suspended status",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapUnsuspendAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetAdapterQueue",
+      "summary": "Return the requests that are waiting in the queue if throttling is enabled",
+      "description": "Return the requests that are waiting in the queue if throttling is enabled",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the adapter queue",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetAdapterQueue"
+      },
+      "task": true
+    },
+    {
+      "name": "iapTroubleshootAdapter",
+      "summary": "Runs troubleshoot script for adapter",
+      "description": "Runs troubleshoot script for adapter",
+      "input": [
+        {
+          "name": "props",
+          "type": "object",
+          "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
+          "required": true,
+          "schema": {
+            "title": "props",
+            "type": "object"
+          }
+        },
+        {
+          "name": "persistFlag",
+          "type": "boolean",
+          "info": "Whether the input properties should be saved",
+          "required": true
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapTroubleshootAdapter"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterHealthcheck",
+      "summary": "Runs healthcheck script for adapter",
+      "description": "Runs healthcheck script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "Whether healthcheck passed or failed"
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterHealthcheck"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterConnectivity",
+      "summary": "Runs connectivity check script for adapter",
+      "description": "Runs connectivity check script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterConnectivity"
+      },
+      "task": true
+    },
+    {
+      "name": "iapRunAdapterBasicGet",
+      "summary": "Runs basicGet script for adapter",
+      "description": "Runs basicGet script for adapter",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing the test results",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapRunAdapterBasicGet"
+      },
+      "task": true
+    },
+    {
+      "name": "iapMoveAdapterEntitiesToDB",
+      "summary": "Moves entities from an adapter into the IAP database",
+      "description": "Moves entities from an adapter into the IAP database",
+      "input": [],
+      "output": {
+        "name": "res",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the response from the mongo transaction",
+        "schema": {
+          "title": "res",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapMoveAdapterEntitiesToDB"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequest",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/genericAdapterRequest"
+      },
+      "task": true
+    },
+    {
+      "name": "genericAdapterRequestNoBasePath",
+      "summary": "Makes the requested generic call",
+      "description": "Makes the requested generic call",
+      "input": [
+        {
+          "name": "uriPath",
+          "type": "string",
+          "info": "the path of the api call - do not include the host, port, base path or version",
+          "description": "the path of the api call",
+          "schema": {
+            "title": "uriPath",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "restMethod",
+          "type": "string",
+          "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
+          "schema": {
+            "title": "restMethod",
+            "type": "string"
+          },
+          "required": true
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "the query parameters to be put on the url (optional)",
+          "description": "the query parameters to be put on the url (optional)",
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "requestBody",
+          "type": "object",
+          "info": "the payload to be sent with the request (optional)",
+          "description": "the payload to be sent with the request (optional)",
+          "schema": {
+            "title": "requestBody",
+            "type": "object"
+          },
+          "required": false
+        },
+        {
+          "name": "addlHeaders",
+          "type": "object",
+          "info": "additional headers to be put on the call (optional)",
+          "description": "additional headers to be put on the call (optional)",
+          "schema": {
+            "title": "addlHeaders",
+            "type": "object"
+          },
+          "required": false
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/genericAdapterRequestNoBasePath"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevice",
+      "summary": "Get the Appliance",
+      "description": "Get the Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "getDevicesFiltered",
+      "summary": "Get Appliances that match the filter",
+      "description": "Get Appliances that match the filter",
+      "input": [
+        {
+          "name": "options",
+          "type": "object",
+          "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
+          "required": true,
+          "schema": {
+            "title": "options",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "array",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "array"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getDevicesFiltered"
+      },
+      "task": true
+    },
+    {
+      "name": "isAlive",
+      "summary": "Checks the status for the provided Appliance",
+      "description": "Checks the status for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "boolean",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "boolean"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/isAlive"
+      },
+      "task": true
+    },
+    {
+      "name": "getConfig",
+      "summary": "Gets a config for the provided Appliance",
+      "description": "Gets a config for the provided Appliance",
+      "input": [
+        {
+          "name": "deviceName",
+          "type": "string",
+          "info": "An Appliance Device Name",
+          "required": true,
+          "schema": {
+            "title": "deviceName",
+            "type": "string"
+          }
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "info": "The format to be returned - this is ignored as we always return json",
+          "required": false,
+          "schema": {
+            "title": "format",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getConfig"
+      },
+      "task": true
+    },
+    {
+      "name": "iapGetDeviceCount",
+      "summary": "Gets a device count from the system",
+      "description": "Gets a device count from the system",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/iapGetDeviceCount"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveAllDevices",
+      "summary": "Retrieve All Devices",
+      "description": "Retrieve All Devices",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/retrieveAllDevices"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceByID",
+      "summary": "Retrieve Device By ID",
+      "description": "Retrieve Device By ID",
+      "input": [
+        {
+          "name": "deviceid",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "deviceid",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceByID"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteDevice",
+      "summary": "Delete Device",
+      "description": "Delete Device",
+      "input": [
+        {
+          "name": "deviceid",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "deviceid",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/deleteDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceBySerialNumber",
+      "summary": "Retrieve Device By Serial Number",
+      "description": "Retrieve Device By Serial Number",
+      "input": [
+        {
+          "name": "serialNumber",
+          "type": "string",
+          "info": "The device serial number as reported in the TR-69 INFORM. For most Calix devices, this is the FSAN Serial Number starting with CXNK, not the Manufacturing Serial Number.: ",
+          "required": true,
+          "schema": {
+            "title": "serialNumber",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceBySerialNumber"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceByMACAddress",
+      "summary": "Retrieve Device By MAC Address",
+      "description": "Retrieve Device By MAC Address",
+      "input": [
+        {
+          "name": "macAddress",
+          "type": "string",
+          "info": "The hardware MAC address as reported in the TR-69 INFORM, in the format 00:11:22:33:44:55: ",
+          "required": true,
+          "schema": {
+            "title": "macAddress",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceByMACAddress"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceByRegistrationID",
+      "summary": "Retrieve Device By Registration ID",
+      "description": "Retrieve Device By Registration ID",
+      "input": [
+        {
+          "name": "registrationId",
+          "type": "string",
+          "info": "The Calix ONT Registration ID (aka RONTA) as programmed locally on the device: ",
+          "required": true,
+          "schema": {
+            "title": "registrationId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceByRegistrationID"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceByIPAddress",
+      "summary": "Retrieve Device By IP Address",
+      "description": "Retrieve Device By IP Address",
+      "input": [
+        {
+          "name": "ipAddress",
+          "type": "string",
+          "info": "The WAN IP address as reported by TR-69 INFORM: ",
+          "required": true,
+          "schema": {
+            "title": "ipAddress",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceByIPAddress"
+      },
+      "task": true
+    },
+    {
+      "name": "createSubscriber",
+      "summary": "Create Subscriber",
+      "description": "Create Subscriber",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "POST body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createSubscriber"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveAllSubscribers",
+      "summary": "Retrieve All Subscribers",
+      "description": "Retrieve All Subscribers",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/retrieveAllSubscribers"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSubscriberByInternalID",
+      "summary": "Retrieve Subscriber by Internal ID",
+      "description": "Retrieve Subscriber by Internal ID",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSubscriberByInternalID"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteSubscriber",
+      "summary": "Delete Subscriber",
+      "description": "Delete Subscriber",
+      "input": [
+        {
+          "name": "id",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "id",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/deleteSubscriber"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSubscriberByCustomIdSubscriberID",
+      "summary": "Retrieve Subscriber by customId/SubscriberID",
+      "description": "Retrieve Subscriber by customId/SubscriberID",
+      "input": [
+        {
+          "name": "customId",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "customId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSubscriberByCustomIdSubscriberID"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSubscriberByName",
+      "summary": "Retrieve Subscriber by Name",
+      "description": "Retrieve Subscriber by Name",
+      "input": [
+        {
+          "name": "name",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "name",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSubscriberByName"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSubscribersByPhoneNumber",
+      "summary": "Retrieve Subscribers by Phone Number",
+      "description": "Retrieve Subscribers by Phone Number",
+      "input": [
+        {
+          "name": "phone",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "phone",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSubscribersByPhoneNumber"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSubscriberByEmailAddress",
+      "summary": "Retrieve Subscriber by Email Address",
+      "description": "Retrieve Subscriber by Email Address",
+      "input": [
+        {
+          "name": "email",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "email",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSubscriberByEmailAddress"
+      },
+      "task": true
+    },
+    {
+      "name": "updateSubscriberOrReplaceAssociatedSystem",
+      "summary": "Update Subscriber or replace associated system",
+      "description": "Update Subscriber or replace associated system",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "PUT body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        },
+        {
+          "name": "customId",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "customId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/updateSubscriberOrReplaceAssociatedSystem"
+      },
+      "task": true
+    },
+    {
+      "name": "createProvisioningRecord",
+      "summary": "Create Provisioning Record",
+      "description": "Create Provisioning Record",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "POST body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/createProvisioningRecord"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveAllProvisioningRecords",
+      "summary": "Retrieve All Provisioning Records",
+      "description": "Retrieve All Provisioning Records",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/retrieveAllProvisioningRecords"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveProvisioningRecordByInternalID",
+      "summary": "Retrieve Provisioning Record by Internal ID",
+      "description": "Retrieve Provisioning Record by Internal ID",
+      "input": [
+        {
+          "name": "provisioningRecordId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "provisioningRecordId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveProvisioningRecordByInternalID"
+      },
+      "task": true
+    },
+    {
+      "name": "deleteProvisioningRecord",
+      "summary": "Delete Provisioning Record",
+      "description": "Delete Provisioning Record",
+      "input": [
+        {
+          "name": "provisioningRecordId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "provisioningRecordId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/deleteProvisioningRecord"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveProvisioningRecordsByDevice",
+      "summary": "Retrieve Provisioning Records by Device",
+      "description": "Retrieve Provisioning Records by Device",
+      "input": [
+        {
+          "name": "deviceId",
+          "type": "string",
+          "info": "Device ID (FSAN/serial/RegID/MAC): ",
+          "required": true,
+          "schema": {
+            "title": "deviceId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveProvisioningRecordsByDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveProvisioningRecordsBySubscriber",
+      "summary": "Retrieve Provisioning Records by Subscriber",
+      "description": "Retrieve Provisioning Records by Subscriber",
+      "input": [
+        {
+          "name": "subscriberId",
+          "type": "string",
+          "info": "Internal ID value of the associated Subscriber record: ",
+          "required": true,
+          "schema": {
+            "title": "subscriberId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveProvisioningRecordsBySubscriber"
+      },
+      "task": true
+    },
+    {
+      "name": "modifyProvisioningRecord",
+      "summary": "Modify Provisioning Record",
+      "description": "Modify Provisioning Record",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "PUT body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        },
+        {
+          "name": "provRecordId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "provRecordId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/modifyProvisioningRecord"
+      },
+      "task": true
+    },
+    {
+      "name": "operateTR69Device",
+      "summary": "TR-69 Device Operations",
+      "description": "TR-69 Device Operations",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "POST body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/operateTR69Device"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveAllDeviceGroups",
+      "summary": "Retrieve All Device Groups",
+      "description": "Retrieve All Device Groups",
+      "input": [],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "GET",
+        "path": "/retrieveAllDeviceGroups"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveDeviceGroupByID",
+      "summary": "Retrieve Device Group by ID",
+      "description": "Retrieve Device Group by ID",
+      "input": [
+        {
+          "name": "groupId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "groupId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveDeviceGroupByID"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveAllStaticGroupMemberships",
+      "summary": "Retrieve All Static Group Memberships",
+      "description": "Retrieve All Static Group Memberships",
+      "input": [
+        {
+          "name": "bDiscovered",
+          "type": "boolean",
+          "info": "If present, this flag returns only Discovered devices (those which have successfully checked in to the ACS).: ",
+          "required": false,
+          "schema": {
+            "title": "bDiscovered",
+            "type": "boolean"
+          }
+        },
+        {
+          "name": "bUndiscovered",
+          "type": "boolean",
+          "info": "If present, this flag returns only devices which have not checked in to the ACS).: ",
+          "required": false,
+          "schema": {
+            "title": "bUndiscovered",
+            "type": "boolean"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveAllStaticGroupMemberships"
+      },
+      "task": true
+    },
+    {
+      "name": "addADeviceOrProvisioningRecordToAStaticGroup",
+      "summary": "Add a Device or Provisioning Record to a Static Group",
+      "description": "Add a Device or Provisioning Record to a Static Group",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": "POST body parameter: ",
+          "required": true,
+          "schema": {
+            "title": "body",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/addADeviceOrProvisioningRecordToAStaticGroup"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveStaticGroupMembershipsByDevice",
+      "summary": "Retrieve Static Group Memberships by Device",
+      "description": "Retrieve Static Group Memberships by Device",
+      "input": [
+        {
+          "name": "memberInfo",
+          "type": "string",
+          "info": "One of: FSAN ID, Serial number, Registration ID, or MAC address.\nUse any of these strings to search for membership information for a matching device.: ",
+          "required": true,
+          "schema": {
+            "title": "memberInfo",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveStaticGroupMembershipsByDevice"
+      },
+      "task": true
+    },
+    {
+      "name": "removeADeviceFromAllStaticGroups",
+      "summary": "Remove a device from all Static Groups",
+      "description": "Remove a device from all Static Groups",
+      "input": [
+        {
+          "name": "memberInfo",
+          "type": "string",
+          "info": ": ",
+          "required": true,
+          "schema": {
+            "title": "memberInfo",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/removeADeviceFromAllStaticGroups"
+      },
+      "task": true
+    },
+    {
+      "name": "retrieveSingleStaticGroupMembershipRecord",
+      "summary": "Retrieve Single Static Group Membership Record",
+      "description": "Retrieve Single Static Group Membership Record",
+      "input": [
+        {
+          "name": "groupMembershipId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "groupMembershipId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/retrieveSingleStaticGroupMembershipRecord"
+      },
+      "task": true
+    },
+    {
+      "name": "removeADeviceFromAStaticGroupByMembershipID",
+      "summary": "Remove a device from a Static Group by membership ID",
+      "description": "Remove a device from a Static Group by membership ID",
+      "input": [
+        {
+          "name": "membershipId",
+          "type": "string",
+          "info": "path parameter: ",
+          "required": true,
+          "schema": {
+            "title": "membershipId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/removeADeviceFromAStaticGroupByMembershipID"
+      },
+      "task": true
+    },
+    {
+      "name": "removeADeviceFromAStaticGroupByGroupIDAndDevice",
+      "summary": "Remove a device from a Static Group by group ID and device",
+      "description": "Remove a device from a Static Group by group ID and device",
+      "input": [
+        {
+          "name": "groupId",
+          "type": "string",
+          "info": "The _id value of the Static Group to remove the device from.: ",
+          "required": true,
+          "schema": {
+            "title": "groupId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "memberInfo",
+          "type": "string",
+          "info": "One of: FSAN ID, Serial number, Registration ID, or MAC address.\nUse any of these strings to select the device to remove.: ",
+          "required": true,
+          "schema": {
+            "title": "memberInfo",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/removeADeviceFromAStaticGroupByGroupIDAndDevice"
+      },
+      "task": true
+    }
+  ],
+  "views": []
+}