@itentialopensource/adapter-meraki 0.8.4 → 1.0.0

package/entities/StaticRoutes/action.json

@@ -0,0 +1,208 @@
+{
+  "actions": [
+    {
+      "name": "listLayer3StaticRoutesForASwitch",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listLayer3StaticRoutesForASwitch-default.json"
+        }
+      ]
+    },
+    {
+      "name": "createALayer3StaticRouteForASwitch",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createALayer3StaticRouteForASwitch-default.json"
+        }
+      ]
+    },
+    {
+      "name": "returnALayer3StaticRouteForASwitch",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/returnALayer3StaticRouteForASwitch-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateALayer3StaticRouteForASwitch",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateALayer3StaticRouteForASwitch-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteALayer3StaticRouteForASwitch",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/devices/{pathv1}/switch/routing/staticRoutes/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "listLayer3StaticRoutesForASwitchStack",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listLayer3StaticRoutesForASwitchStack-default.json"
+        }
+      ]
+    },
+    {
+      "name": "createALayer3StaticRouteForASwitchStack",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createALayer3StaticRouteForASwitchStack-default.json"
+        }
+      ]
+    },
+    {
+      "name": "returnALayer3StaticRouteForASwitchStack",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/returnALayer3StaticRouteForASwitchStack-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateALayer3StaticRouteForASwitchStack",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateALayer3StaticRouteForASwitchStack-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteALayer3StaticRouteForASwitchStack",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/networks/{pathv1}/switch/stacks/{pathv2}/routing/staticRoutes/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/StaticRoutes/mockdatafiles/createALayer3StaticRouteForASwitch-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/mockdatafiles/createALayer3StaticRouteForASwitchStack-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/mockdatafiles/listLayer3StaticRoutesForASwitch-default.json

@@ -0,0 +1,10 @@
+[
+  {
+    "staticRouteId": "1234",
+    "name": "My route",
+    "subnet": "192.168.1.0/24",
+    "nextHopIp": "1.2.3.4",
+    "advertiseViaOspfEnabled": false,
+    "preferOverOspfRoutesEnabled": false
+  }
+]

package/entities/StaticRoutes/mockdatafiles/listLayer3StaticRoutesForASwitchStack-default.json

@@ -0,0 +1,10 @@
+[
+  {
+    "staticRouteId": "1234",
+    "name": "My route",
+    "subnet": "192.168.1.0/24",
+    "nextHopIp": "1.2.3.4",
+    "advertiseViaOspfEnabled": false,
+    "preferOverOspfRoutesEnabled": false
+  }
+]

package/entities/StaticRoutes/mockdatafiles/returnALayer3StaticRouteForASwitch-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/mockdatafiles/returnALayer3StaticRouteForASwitchStack-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/mockdatafiles/updateALayer3StaticRouteForASwitch-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/mockdatafiles/updateALayer3StaticRouteForASwitchStack-default.json

@@ -0,0 +1,8 @@
+{
+  "staticRouteId": "1234",
+  "name": "My route",
+  "subnet": "192.168.1.0/24",
+  "nextHopIp": "1.2.3.4",
+  "advertiseViaOspfEnabled": false,
+  "preferOverOspfRoutesEnabled": false
+}

package/entities/StaticRoutes/schema.json

@@ -0,0 +1,28 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "listLayer3StaticRoutesForASwitch",
+        "createALayer3StaticRouteForASwitch",
+        "returnALayer3StaticRouteForASwitch",
+        "updateALayer3StaticRouteForASwitch",
+        "deleteALayer3StaticRouteForASwitch",
+        "listLayer3StaticRoutesForASwitchStack",
+        "createALayer3StaticRouteForASwitchStack",
+        "returnALayer3StaticRouteForASwitchStack",
+        "updateALayer3StaticRouteForASwitchStack",
+        "deleteALayer3StaticRouteForASwitchStack"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Stats/action.json

@@ -0,0 +1,25 @@
+{
+  "actions": [
+    {
+      "name": "showVPNhistorystatfornetworksinanorganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/appliance/vpn/stats?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/showVPNhistorystatfornetworksinanorganization-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/Stats/mockdatafiles/showVPNhistorystatfornetworksinanorganization-default.json

@@ -0,0 +1,158 @@
+[
+  {
+    "networkId": "N_12345678",
+    "networkName": "San Francisco Office",
+    "merakiVpnPeers": [
+      {
+        "networkId": "L_23456789",
+        "networkName": "New York Office",
+        "usageSummary": {
+          "receivedInKilobytes": 1234567,
+          "sentInKilobytes": 2345678
+        },
+        "latencySummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgLatencyMs": 15,
+            "minLatencyMs": 10,
+            "maxLatencyMs": 30
+          },
+          {
+            "senderUplink": "wan2",
+            "receiverUplink": "wan1",
+            "avgLatencyMs": 15,
+            "minLatencyMs": 10,
+            "maxLatencyMs": 30
+          }
+        ],
+        "lossPercentageSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgLossPercentage": 0,
+            "minLossPercentage": 0,
+            "maxLossPercentage": 0.1
+          },
+          {
+            "senderUplink": "wan2",
+            "receiverUplink": "wan1",
+            "avgLossPercentage": 0,
+            "minLossPercentage": 0,
+            "maxLossPercentage": 0.1
+          }
+        ],
+        "jitterSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgJitter": 0.01,
+            "minJitter": 0,
+            "maxJitter": 0.25
+          },
+          {
+            "senderUplink": "wan2",
+            "receiverUplink": "wan1",
+            "avgJitter": 0.01,
+            "minJitter": 0,
+            "maxJitter": 0.25
+          }
+        ],
+        "mosSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgMos": 4.1,
+            "minMos": 4,
+            "maxMos": 4.2
+          },
+          {
+            "senderUplink": "wan2",
+            "receiverUplink": "wan1",
+            "avgMos": 4.1,
+            "minMos": 4,
+            "maxMos": 4.2
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "networkId": "L_23456789",
+    "networkName": "New York Office",
+    "merakiVpnPeers": [
+      {
+        "networkId": "N_12345678",
+        "networkName": "San Francisco Office",
+        "usageSummary": {
+          "receivedInKilobytes": 2345678,
+          "sentInKilobytes": 1234567
+        },
+        "latencySummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgLatencyMs": 15,
+            "minLatencyMs": 10,
+            "maxLatencyMs": 30
+          },
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan2",
+            "avgLatencyMs": 15,
+            "minLatencyMs": 10,
+            "maxLatencyMs": 30
+          }
+        ],
+        "lossPercentageSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgLossPercentage": 0,
+            "minLossPercentage": 0,
+            "maxLossPercentage": 0.1
+          },
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan2",
+            "avgLossPercentage": 0,
+            "minLossPercentage": 0,
+            "maxLossPercentage": 0.1
+          }
+        ],
+        "jitterSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgJitter": 0.01,
+            "minJitter": 0,
+            "maxJitter": 0.25
+          },
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan2",
+            "avgJitter": 0.01,
+            "minJitter": 0,
+            "maxJitter": 0.25
+          }
+        ],
+        "mosSummaries": [
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan1",
+            "avgMos": 4.1,
+            "minMos": 4,
+            "maxMos": 4.2
+          },
+          {
+            "senderUplink": "wan1",
+            "receiverUplink": "wan2",
+            "avgMos": 4.1,
+            "minMos": 4,
+            "maxMos": 4.2
+          }
+        ]
+      }
+    ]
+  }
+]

package/entities/Stats/schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "showVPNhistorystatfornetworksinanorganization"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Statuses/action.json

@@ -0,0 +1,150 @@
+{
+  "actions": [
+    {
+      "name": "listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/appliance/uplink/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listtheuplinkstatusofeveryMerakiMXandZseriesappliancesintheorganization-default.json"
+        }
+      ]
+    },
+    {
+      "name": "fetchOnboardingStatusOfCameras",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/fetchOnboardingStatusOfCameras-default.json"
+        }
+      ]
+    },
+    {
+      "name": "notifyThatCredentialHandoffToCameraHasCompleted",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/camera/onboarding/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/notifyThatCredentialHandoffToCameraHasCompleted-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/cellularGateway/uplink/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listtheuplinkstatusofeveryMerakiMGcellulargatewayintheorganization-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/uplinks/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listtheuplinkstatusofeveryMerakiMXMGandZseriesdevicesintheorganization-default.json"
+        }
+      ]
+    },
+    {
+      "name": "showVPNstatusfornetworksinanorganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/appliance/vpn/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/showVPNstatusfornetworksinanorganization-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listTheStatusOfEveryMerakiDeviceInTheOrganization",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/organizations/{pathv1}/devices/statuses?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listTheStatusOfEveryMerakiDeviceInTheOrganization-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/Statuses/mockdatafiles/fetchOnboardingStatusOfCameras-default.json

@@ -0,0 +1,8 @@
+[
+  {
+    "networkId": "N_12345",
+    "serial": "Q2AB-CDEF-GHIJ",
+    "status": "pending onboarding",
+    "updatedAt": "2021/03/24 15:23:47.101068 -0700"
+  }
+]