@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/DevicesV2/action.json

@@ -0,0 +1,186 @@
+{
+  "actions": [
+    {
+      "name": "createDeviceV2",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v2/device?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getDeviceListV2",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v2/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": "getDeviceDetailsV2",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v2/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": "updateDeviceV2",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v2/device/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "archiveDeviceV2",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/api/v2/device/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/archiveDeviceV2-default.json"
+        }
+      ]
+    },
+    {
+      "name": "enableDeviceV2",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v2/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/enableDeviceV2-default.json"
+        }
+      ]
+    },
+    {
+      "name": "disableDeviceV2",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v2/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/disableDeviceV2-default.json"
+        }
+      ]
+    },
+    {
+      "name": "restoreDeviceV2",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v2/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/restoreDeviceV2-default.json"
+        }
+      ]
+    },
+    {
+      "name": "renewDeviceCertificateV2",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v2/device/{pathv1}/renew?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/DevicesV2/mockdatafiles/archiveDeviceV2-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/DevicesV2/mockdatafiles/disableDeviceV2-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/DevicesV2/mockdatafiles/enableDeviceV2-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/DevicesV2/mockdatafiles/restoreDeviceV2-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/DevicesV2/schema.json

@@ -0,0 +1,115 @@
+{
+  "$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": [
+        "createDeviceV2",
+        "getDeviceListV2",
+        "getDeviceDetailsV2",
+        "updateDeviceV2",
+        "archiveDeviceV2",
+        "enableDeviceV2",
+        "disableDeviceV2",
+        "restoreDeviceV2",
+        "renewDeviceCertificateV2"
+      ],
+      "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"
+    },    
+    "deviceId": {
+      "type": "string",
+      "description": "Device ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_id"
+    }
+  },
+  "definitions": {}
+}