@itentialopensource/adapter-sendgrid 0.1.1

package/entities/Alerts/action.json

@@ -0,0 +1,106 @@
+{
+  "actions": [
+    {
+      "name": "postAlerts",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/alerts?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getAlerts",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/alerts?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getAlertsAlertId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/alerts/{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": "deleteAlertsAlertId",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/alerts/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "patchAlertsAlertId",
+      "protocol": "REST",
+      "method": "PATCH",
+      "entitypath": "{base_path}/{version}/alerts/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/Alerts/schema.json

@@ -0,0 +1,34 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "postAlerts",
+      "enum": [
+        "postAlerts",
+        "getAlerts",
+        "getAlertsAlertId",
+        "deleteAlertsAlertId",
+        "patchAlertsAlertId"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "alertId": {
+      "type": "number",
+      "description": "The ID of the alert you would like to retrieve.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "alert_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/BlocksAPI/action.json

@@ -0,0 +1,86 @@
+{
+  "actions": [
+    {
+      "name": "getSuppressionBlocks",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/suppression/blocks?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteSuppressionBlocks",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/suppression/blocks?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getSuppressionBlocksEmail",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/suppression/blocks/{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": "deleteSuppressionBlocksEmail",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/suppression/blocks/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/BlocksAPI/schema.json

@@ -0,0 +1,44 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "getSuppressionBlocks",
+      "enum": [
+        "getSuppressionBlocks",
+        "deleteSuppressionBlocks",
+        "getSuppressionBlocksEmail",
+        "deleteSuppressionBlocksEmail"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "startTime": {
+      "type": "number",
+      "description": "The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "start_time"
+    },
+    "endTime": {
+      "type": "number",
+      "description": "The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "end_time"
+    }
+  },
+  "definitions": {}
+}

package/entities/BouncesAPI/action.json

@@ -0,0 +1,86 @@
+{
+  "actions": [
+    {
+      "name": "getSuppressionBounces",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/suppression/bounces?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteSuppressionBounces",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/suppression/bounces?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getSuppressionBouncesEmail",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/suppression/bounces/{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": "deleteSuppressionBouncesEmail",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/suppression/bounces/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/BouncesAPI/schema.json

@@ -0,0 +1,55 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "getSuppressionBounces",
+      "enum": [
+        "getSuppressionBounces",
+        "deleteSuppressionBounces",
+        "getSuppressionBouncesEmail",
+        "deleteSuppressionBouncesEmail"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "startTime": {
+      "type": "number",
+      "description": "Refers start of the time range in unix timestamp when a bounce was created (inclusive).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "start_time"
+    },
+    "endTime": {
+      "type": "number",
+      "description": "Refers end of the time range in unix timestamp when a bounce was created (inclusive).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "end_time"
+    },
+    "emailAddress": {
+      "type": "string",
+      "description": "The email address you would like to remove from the bounce list.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "email_address"
+    }
+  },
+  "definitions": {}
+}

package/entities/CSVUIOnly/action.json

@@ -0,0 +1,45 @@
+{
+  "actions": [
+    {
+      "name": "postV3MessagesDownload",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/messages/download?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getV3MessagesDownloadDownloadUuid",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/messages/download/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/CSVUIOnly/schema.json

@@ -0,0 +1,31 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": true,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "postV3MessagesDownload",
+      "enum": [
+        "postV3MessagesDownload",
+        "getV3MessagesDownloadDownloadUuid"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "downloadUuid": {
+      "type": "string",
+      "description": "UUID used to locate the download csv request entry in the DB.\n\nThis is the UUID provided in the email sent to the user when their csv file is ready to download",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "download_uuid"
+    }
+  },
+  "definitions": {}
+}