@itentialopensource/adapter-sendgrid 0.1.1

package/entities/MarketingCampaignsStats/schema.json

@@ -0,0 +1,147 @@
+{
+  "$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": "getallAutomationStats",
+      "enum": [
+        "getallAutomationStats",
+        "getAutomationStat",
+        "getallSinglesendStats",
+        "getSinglesendStat",
+        "getAutomationLinkStat",
+        "getSinglesendLinkStat",
+        "getSinglesendStatsExport",
+        "getAutomationsStatsExport"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "automationIds": {
+      "type": "array",
+      "description": "This endpoint returns all automation IDs if no `automation_ids` are specified.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "automation_ids"
+    },
+    "pageSize": {
+      "type": "number",
+      "description": "The number of elements you want returned on each page.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "page_size"
+    },
+    "pageToken": {
+      "type": "string",
+      "description": "The stats endpoints are paginated. To get the next page, call the passed `_metadata.next` URL. If `_metadata.prev` doesn't exist, you're at the first page. Similarly, if ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "page_token"
+    },
+    "groupBy": {
+      "type": "array",
+      "description": "A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "group_by"
+    },
+    "stepIds": {
+      "type": "array",
+      "description": "Comma-separated list of `step_ids` that you want the link stats for.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "step_ids"
+    },
+    "aggregatedBy": {
+      "type": "string",
+      "description": "Dictates how the stats are time-sliced. Currently, `\"total\"` and `\"day\"` are supported.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "aggregated_by"
+    },
+    "startDate": {
+      "type": "string",
+      "description": "Format: `YYYY-MM-DD`. If this parameter is included, the stats' start date is included in the search.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "start_date"
+    },
+    "endDate": {
+      "type": "string",
+      "description": "Format: `YYYY-MM-DD`.If this parameter is included, the stats' end date is included in the search.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "end_date"
+    },
+    "singlesendIds": {
+      "type": "array",
+      "description": "This endpoint returns all Single Send IDs if no IDs are included in `singlesend_ids`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "singlesend_ids"
+    },
+    "abVariationId": {
+      "type": "string",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ab_variation_id"
+    },
+    "abPhaseId": {
+      "type": "string",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ab_phase_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/Query/action.json

@@ -0,0 +1,46 @@
+{
+  "actions": [
+    {
+      "name": "getMessages",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/messages?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getV3MessagesMsgId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/messages/{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/Query/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": "getMessages",
+      "enum": [
+        "getMessages",
+        "getV3MessagesMsgId"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "msgId": {
+      "type": "string",
+      "description": "The ID of the message you are requesting details for.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "msg_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/ReverseDNS/action.json

@@ -0,0 +1,106 @@
+{
+  "actions": [
+    {
+      "name": "postWhitelabelIps",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/whitelabel/ips?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getWhitelabelIps",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/whitelabel/ips?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "postWhitelabelIpsIdValidate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/whitelabel/ips/{pathv1}/validate?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getWhitelabelIpsId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/whitelabel/ips/{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": "deleteWhitelabelIpsId",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/whitelabel/ips/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/ReverseDNS/schema.json

@@ -0,0 +1,23 @@
+{
+  "$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": "postWhitelabelIps",
+      "enum": [
+        "postWhitelabelIps",
+        "getWhitelabelIps",
+        "postWhitelabelIpsIdValidate",
+        "getWhitelabelIpsId",
+        "deleteWhitelabelIpsId"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/SegmentingContacts/action.json

@@ -0,0 +1,126 @@
+{
+  "actions": [
+    {
+      "name": "postMarketingSegments",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/marketing/segments?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getMarketingSegments",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/marketing/segments?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getMarketingSegmentsSegmentId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/marketing/segments/{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": "patchMarketingSegmentsSegmentId",
+      "protocol": "REST",
+      "method": "PATCH",
+      "entitypath": "{base_path}/{version}/marketing/segments/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteMarketingSegmentsSegmentId",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/marketing/segments/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "postMarketingSegmentsDelete",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/marketing/segments/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/SegmentingContacts/schema.json

@@ -0,0 +1,68 @@
+{
+  "$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": "postMarketingSegments",
+      "enum": [
+        "postMarketingSegments",
+        "getMarketingSegments",
+        "getMarketingSegmentsSegmentId",
+        "patchMarketingSegmentsSegmentId",
+        "deleteMarketingSegmentsSegmentId",
+        "postMarketingSegmentsDelete"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "parentListIds": {
+      "type": "string",
+      "description": "A comma separated list of list ids to be used when searching for segments with the specified parent_list_id, no more than 50 is allowed",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "parent_list_ids"
+    },
+    "noParentListId": {
+      "type": "boolean",
+      "description": "If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter.  If the value is not present it defaults to 'false'.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "no_parent_list_id"
+    },
+    "segmentId": {
+      "type": "string",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "segment_id"
+    },
+    "queryJson": {
+      "type": "boolean",
+      "description": "Defaults to `false`.  Set to `true` to return the parsed SQL AST as a JSON object in the field `query_json`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "query_json"
+    }
+  },
+  "definitions": {}
+}

package/entities/SegmentingContactsV2/action.json

@@ -0,0 +1,86 @@
+{
+  "actions": [
+    {
+      "name": "postSegments",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/marketing/segments/2.0?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getSegments",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/marketing/segments/2.0?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "patchSegmentsSegmentId",
+      "protocol": "REST",
+      "method": "PATCH",
+      "entitypath": "{base_path}/{version}/marketing/segments/2.0/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getSegmentsSegmentId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/marketing/segments/2.0/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}