@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/DeviceProfiles/mockdatafiles/listdeviceprofiles-default.json

@@ -0,0 +1,53 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "pagination": true,
+  "next": false,
+  "total": 2,
+  "records": [
+    {
+      "device_api_allow_read": true,
+      "device_api_allow_write": true,
+      "device_api_allow_revoke": true,
+      "device_api_allow_renew_certificate": true,
+      "device_api_allow_enroll_certificate": false,
+      "name": "Example device profile",
+      "description": "Example description",
+      "id": "7af1665a-312b-4623-bc42-4ecdc3a991e4",
+      "status": "ACTIVE",
+      "fields": [
+        {
+          "id": "a23359cf-4d46-4a6f-8836-b57ade0ba490",
+          "name": "mandatory",
+          "mandatory": true
+        },
+        {
+          "id": "5cec6af9-03d4-42a2-8a6f-398e02f9ff06",
+          "name": "optional",
+          "mandatory": false
+        }
+      ],
+      "division": {
+        "id": "7916bac3-9e40-42bc-9ca1-9e6be33ed4f5",
+        "name": "IoT Account"
+      },
+      "account_id": "5765eaa2-4e4d-4505-8f43-4193aeef2137"
+    },
+    {
+      "device_api_allow_read": false,
+      "device_api_allow_write": false,
+      "device_api_allow_revoke": false,
+      "device_api_allow_renew_certificate": false,
+      "device_api_allow_enroll_certificate": false,
+      "name": "Example device profile 2",
+      "id": "14b5b58b-170a-4282-ad6a-f7323361a88e",
+      "status": "ACTIVE",
+      "fields": [],
+      "division": {
+        "id": "16ab78eb-09c3-449a-86a8-542c95edd310",
+        "name": "External Account"
+      },
+      "account_id": "5c84f89c-46d3-4554-a2d2-c3daa81b153f"
+    }
+  ]
+}

package/entities/DeviceProfiles/mockdatafiles/updateDeviceProfile-default.json

@@ -0,0 +1,28 @@
+{
+  "id": "dcfe811c-ecf1-4d2e-bf44-462963bc4ade",
+  "name": "Device profile example",
+  "description": "An example device profile",
+  "status": "ACTIVE",
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_revoke": true,
+  "device_api_allow_renew_certificate": true,
+  "device_api_allow_enroll_certificate": false,
+  "fields": [
+    {
+      "id": "226ca489-1ce2-49ef-ab23-5968ae6440ef",
+      "name": "mandatory",
+      "mandatory": true
+    },
+    {
+      "id": "661820ce-4d8b-45bd-af2b-4baf924b8650",
+      "name": "optional",
+      "mandatory": false
+    }
+  ],
+  "division": {
+    "id": "d5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "IoT Account"
+  },
+  "account_id": "f92834ce-cdea-1584-b154-193bb198345e"
+}

package/entities/DeviceProfiles/schema.json

@@ -0,0 +1,57 @@
+{
+  "$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": [
+        "createDeviceProfile",
+        "listdeviceprofiles",
+        "getDeviceProfile",
+        "updateDeviceProfile",
+        "deleteDeviceProfile",
+        "restoreDeviceProfile"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to device profiles for an account with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits results to device profiles for a division with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "deviceProfileId": {
+      "type": "string",
+      "description": "Device profile ID (UUID)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_profile_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/Devices/action.json

@@ -0,0 +1,166 @@
+{
+  "actions": [
+    {
+      "name": "createDevice",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/device?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getDeviceList",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/device?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getDeviceDetails",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "updateDevice",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "archiveDevice",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/archiveDevice-default.json"
+        }
+      ]
+    },
+    {
+      "name": "enableDevice",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}/enable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/enableDevice-default.json"
+        }
+      ]
+    },
+    {
+      "name": "disableDevice",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}/disable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/disableDevice-default.json"
+        }
+      ]
+    },
+    {
+      "name": "restoreDevice",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device/{pathv1}/undelete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/restoreDevice-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/Devices/mockdatafiles/archiveDevice-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "division": {
+    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "Mock Division 1"
+  },
+  "device_identifier": "New Device",
+  "device_profile": {
+    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
+    "name": "Device Profile"
+  },
+  "created": "2020-04-22T07:13:20Z",
+  "updated": "2020-04-24T09:23:21Z",
+  "status": "DELETED",
+  "fields": [
+    {
+      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
+      "name": "Mandatory Field",
+      "value": "updated mandatory value",
+      "mandatory": true
+    },
+    {
+      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
+      "name": "Optional Field",
+      "value": "updated optional value",
+      "mandatory": false
+    }
+  ],
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_renew_certificate": true
+}

package/entities/Devices/mockdatafiles/disableDevice-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "division": {
+    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "Mock Division 1"
+  },
+  "device_identifier": "New Device",
+  "device_profile": {
+    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
+    "name": "Device Profile"
+  },
+  "created": "2020-04-22T07:13:20Z",
+  "updated": "2020-04-24T09:23:21Z",
+  "status": "DISABLED",
+  "fields": [
+    {
+      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
+      "name": "Mandatory Field",
+      "value": "updated mandatory value",
+      "mandatory": true
+    },
+    {
+      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
+      "name": "Optional Field",
+      "value": "updated optional value",
+      "mandatory": false
+    }
+  ],
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_renew_certificate": true
+}

package/entities/Devices/mockdatafiles/enableDevice-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "division": {
+    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "Mock Division 1"
+  },
+  "device_identifier": "New Device",
+  "device_profile": {
+    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
+    "name": "Device Profile"
+  },
+  "created": "2020-04-22T07:13:20Z",
+  "updated": "2020-04-24T09:23:21Z",
+  "status": "ACTIVE",
+  "fields": [
+    {
+      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
+      "name": "Mandatory Field",
+      "value": "updated mandatory value",
+      "mandatory": true
+    },
+    {
+      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
+      "name": "Optional Field",
+      "value": "updated optional value",
+      "mandatory": false
+    }
+  ],
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_renew_certificate": true
+}

package/entities/Devices/mockdatafiles/restoreDevice-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "division": {
+    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "Mock Division 1"
+  },
+  "device_identifier": "New Device",
+  "device_profile": {
+    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
+    "name": "Device Profile"
+  },
+  "created": "2020-04-22T07:13:20Z",
+  "updated": "2020-04-24T09:23:21Z",
+  "status": "ACTIVE",
+  "fields": [
+    {
+      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
+      "name": "Mandatory Field",
+      "value": "updated mandatory value",
+      "mandatory": true
+    },
+    {
+      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
+      "name": "Optional Field",
+      "value": "updated optional value",
+      "mandatory": false
+    }
+  ],
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_renew_certificate": true
+}

package/entities/Devices/schema.json

@@ -0,0 +1,103 @@
+{
+  "$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": [
+        "createDevice",
+        "getDeviceList",
+        "getDeviceDetails",
+        "updateDevice",
+        "archiveDevice",
+        "enableDevice",
+        "disableDevice",
+        "restoreDevice"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "deviceIdentifier": {
+      "type": "string",
+      "description": "Limits response data to records that use a specific device identifier.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_identifier"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits response data to device records created after the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_from"
+    },    
+    "createdTo": {
+      "type": "string",
+      "description": "Limits response data to device records created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits response data to device records associated with a specific division ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "updatedFrom": {
+      "type": "string",
+      "description": "Limits response data to device records updated after a specific date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "updated_from"
+    },    
+    "updatedTo": {
+      "type": "string",
+      "description": "Limits response data to device records updated before a specific date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "updated_to"
+    },    
+    "deviceProfileId": {
+      "type": "string",
+      "description": "Limits response data to device records with a specific device profile ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_profile_id"
+    }
+  },
+  "definitions": {}
+}