@itentialopensource/adapter-sendgrid 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (182) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/AUTH.md +31 -0
  5. package/BROKER.md +211 -0
  6. package/CALLS.md +2211 -0
  7. package/CODE_OF_CONDUCT.md +43 -0
  8. package/CONTRIBUTING.md +13 -0
  9. package/ENHANCE.md +69 -0
  10. package/LICENSE +201 -0
  11. package/PROPERTIES.md +646 -0
  12. package/README.md +343 -0
  13. package/SUMMARY.md +9 -0
  14. package/SYSTEMINFO.md +20 -0
  15. package/TAB1.md +11 -0
  16. package/TAB2.md +302 -0
  17. package/TROUBLESHOOT.md +47 -0
  18. package/adapter.js +38033 -0
  19. package/adapterBase.js +1452 -0
  20. package/entities/.generic/action.json +214 -0
  21. package/entities/.generic/schema.json +28 -0
  22. package/entities/.system/action.json +50 -0
  23. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  24. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  25. package/entities/.system/schema.json +19 -0
  26. package/entities/.system/schemaTokenReq.json +53 -0
  27. package/entities/.system/schemaTokenResp.json +53 -0
  28. package/entities/APIKeyPermissions/action.json +25 -0
  29. package/entities/APIKeyPermissions/schema.json +19 -0
  30. package/entities/APIKeys/action.json +126 -0
  31. package/entities/APIKeys/schema.json +35 -0
  32. package/entities/Alerts/action.json +106 -0
  33. package/entities/Alerts/schema.json +34 -0
  34. package/entities/BlocksAPI/action.json +86 -0
  35. package/entities/BlocksAPI/schema.json +44 -0
  36. package/entities/BouncesAPI/action.json +86 -0
  37. package/entities/BouncesAPI/schema.json +55 -0
  38. package/entities/CSVUIOnly/action.json +45 -0
  39. package/entities/CSVUIOnly/schema.json +31 -0
  40. package/entities/CampaignsAPI/action.json +227 -0
  41. package/entities/CampaignsAPI/schema.json +40 -0
  42. package/entities/CancelScheduledSends/action.json +147 -0
  43. package/entities/CancelScheduledSends/schema.json +36 -0
  44. package/entities/Categories/action.json +67 -0
  45. package/entities/Categories/schema.json +76 -0
  46. package/entities/Certificates/action.json +106 -0
  47. package/entities/Certificates/schema.json +45 -0
  48. package/entities/Contacts/action.json +270 -0
  49. package/entities/Contacts/schema.json +42 -0
  50. package/entities/ContactsAPICustomFields/action.json +107 -0
  51. package/entities/ContactsAPICustomFields/schema.json +34 -0
  52. package/entities/ContactsAPILists/action.json +207 -0
  53. package/entities/ContactsAPILists/schema.json +72 -0
  54. package/entities/ContactsAPIRecipients/action.json +251 -0
  55. package/entities/ContactsAPIRecipients/schema.json +63 -0
  56. package/entities/ContactsAPISegments/action.json +127 -0
  57. package/entities/ContactsAPISegments/schema.json +57 -0
  58. package/entities/CustomFields/action.json +85 -0
  59. package/entities/CustomFields/schema.json +33 -0
  60. package/entities/DesignsAPI/action.json +188 -0
  61. package/entities/DesignsAPI/schema.json +49 -0
  62. package/entities/DomainAuthentication/action.json +248 -0
  63. package/entities/DomainAuthentication/schema.json +52 -0
  64. package/entities/EmailAddressValidation/action.json +24 -0
  65. package/entities/EmailAddressValidation/schema.json +19 -0
  66. package/entities/EmailCNAMERecords/action.json +24 -0
  67. package/entities/EmailCNAMERecords/schema.json +19 -0
  68. package/entities/IPAccessManagement/action.json +127 -0
  69. package/entities/IPAccessManagement/schema.json +35 -0
  70. package/entities/IPAddresses/action.json +108 -0
  71. package/entities/IPAddresses/schema.json +56 -0
  72. package/entities/IPPools/action.json +146 -0
  73. package/entities/IPPools/schema.json +36 -0
  74. package/entities/IPWarmup/action.json +86 -0
  75. package/entities/IPWarmup/schema.json +33 -0
  76. package/entities/InvalidEmailsAPI/action.json +86 -0
  77. package/entities/InvalidEmailsAPI/schema.json +44 -0
  78. package/entities/LinkBranding/action.json +208 -0
  79. package/entities/LinkBranding/schema.json +39 -0
  80. package/entities/Lists/action.json +147 -0
  81. package/entities/Lists/schema.json +80 -0
  82. package/entities/MailSend/action.json +24 -0
  83. package/entities/MailSend/schema.json +19 -0
  84. package/entities/MarketingCampaignsStats/action.json +172 -0
  85. package/entities/MarketingCampaignsStats/schema.json +147 -0
  86. package/entities/Query/action.json +46 -0
  87. package/entities/Query/schema.json +31 -0
  88. package/entities/ReverseDNS/action.json +106 -0
  89. package/entities/ReverseDNS/schema.json +23 -0
  90. package/entities/SegmentingContacts/action.json +126 -0
  91. package/entities/SegmentingContacts/schema.json +68 -0
  92. package/entities/SegmentingContactsV2/action.json +86 -0
  93. package/entities/SegmentingContactsV2/schema.json +66 -0
  94. package/entities/SegmentingContactsV2Beta/action.json +24 -0
  95. package/entities/SegmentingContactsV2Beta/schema.json +30 -0
  96. package/entities/SendTestEmail/action.json +24 -0
  97. package/entities/SendTestEmail/schema.json +19 -0
  98. package/entities/SenderIdentitiesAPI/action.json +126 -0
  99. package/entities/SenderIdentitiesAPI/schema.json +35 -0
  100. package/entities/SenderVerification/action.json +168 -0
  101. package/entities/SenderVerification/schema.json +26 -0
  102. package/entities/Senders/action.json +24 -0
  103. package/entities/Senders/schema.json +19 -0
  104. package/entities/SettingsEnforcedTLS/action.json +45 -0
  105. package/entities/SettingsEnforcedTLS/schema.json +20 -0
  106. package/entities/SettingsInboundParse/action.json +85 -0
  107. package/entities/SettingsInboundParse/schema.json +22 -0
  108. package/entities/SettingsMail/action.json +271 -0
  109. package/entities/SettingsMail/schema.json +31 -0
  110. package/entities/SettingsPartner/action.json +66 -0
  111. package/entities/SettingsPartner/schema.json +21 -0
  112. package/entities/SettingsTracking/action.json +189 -0
  113. package/entities/SettingsTracking/schema.json +27 -0
  114. package/entities/SingleSends/action.json +227 -0
  115. package/entities/SingleSends/schema.json +51 -0
  116. package/entities/SingleSignOnSettings/action.json +106 -0
  117. package/entities/SingleSignOnSettings/schema.json +23 -0
  118. package/entities/SingleSignOnTeammates/action.json +44 -0
  119. package/entities/SingleSignOnTeammates/schema.json +20 -0
  120. package/entities/SpamReportsAPI/action.json +86 -0
  121. package/entities/SpamReportsAPI/schema.json +44 -0
  122. package/entities/Stats/action.json +151 -0
  123. package/entities/Stats/schema.json +80 -0
  124. package/entities/SubuserMonitorSettings/action.json +85 -0
  125. package/entities/SubuserMonitorSettings/schema.json +33 -0
  126. package/entities/SubuserStatistics/action.json +88 -0
  127. package/entities/SubuserStatistics/schema.json +88 -0
  128. package/entities/SubusersAPI/action.json +126 -0
  129. package/entities/SubusersAPI/schema.json +35 -0
  130. package/entities/SuppressionsGlobalSuppressions/action.json +86 -0
  131. package/entities/SuppressionsGlobalSuppressions/schema.json +44 -0
  132. package/entities/SuppressionsSuppressions/action.json +127 -0
  133. package/entities/SuppressionsSuppressions/schema.json +35 -0
  134. package/entities/SuppressionsUnsubscribeGroups/action.json +106 -0
  135. package/entities/SuppressionsUnsubscribeGroups/schema.json +34 -0
  136. package/entities/Teammates/action.json +228 -0
  137. package/entities/Teammates/schema.json +40 -0
  138. package/entities/TransactionalTemplates/action.json +126 -0
  139. package/entities/TransactionalTemplates/schema.json +57 -0
  140. package/entities/TransactionalTemplatesVersions/action.json +105 -0
  141. package/entities/TransactionalTemplatesVersions/schema.json +45 -0
  142. package/entities/UsersAPI/action.json +189 -0
  143. package/entities/UsersAPI/schema.json +27 -0
  144. package/entities/Webhooks/action.json +148 -0
  145. package/entities/Webhooks/schema.json +58 -0
  146. package/error.json +190 -0
  147. package/metadata.json +77 -0
  148. package/package.json +81 -0
  149. package/pronghorn.json +17316 -0
  150. package/propertiesDecorators.json +14 -0
  151. package/propertiesSchema.json +1574 -0
  152. package/report/adapter-openapi.json +59750 -0
  153. package/report/adapter-openapi.yaml +43964 -0
  154. package/report/adapterInfo.json +10 -0
  155. package/report/auto-adapter-openapi.json +14137 -0
  156. package/report/creationReport.json +2750 -0
  157. package/report/sendgrid.json +48136 -0
  158. package/sampleProperties.json +257 -0
  159. package/test/integration/adapterTestBasicGet.js +83 -0
  160. package/test/integration/adapterTestConnectivity.js +118 -0
  161. package/test/integration/adapterTestIntegration.js +9099 -0
  162. package/test/unit/adapterBaseTestUnit.js +1024 -0
  163. package/test/unit/adapterTestUnit.js +8691 -0
  164. package/utils/adapterInfo.js +206 -0
  165. package/utils/addAuth.js +94 -0
  166. package/utils/artifactize.js +146 -0
  167. package/utils/basicGet.js +50 -0
  168. package/utils/checkMigrate.js +63 -0
  169. package/utils/entitiesToDB.js +179 -0
  170. package/utils/findPath.js +74 -0
  171. package/utils/methodDocumentor.js +273 -0
  172. package/utils/modify.js +152 -0
  173. package/utils/packModificationScript.js +35 -0
  174. package/utils/patches2bundledDeps.js +90 -0
  175. package/utils/pre-commit.sh +32 -0
  176. package/utils/removeHooks.js +20 -0
  177. package/utils/setup.js +33 -0
  178. package/utils/taskMover.js +309 -0
  179. package/utils/tbScript.js +239 -0
  180. package/utils/tbUtils.js +489 -0
  181. package/utils/testRunner.js +298 -0
  182. package/utils/troubleshootingAdapter.js +193 -0
package/entities/Certificates/action.json ADDED
@@ -0,0 +1,106 @@
1
+ {
2
+ "actions": [
3
+ {
4
+ "name": "postSsoCertificates",
5
+ "protocol": "REST",
6
+ "method": "POST",
7
+ "entitypath": "{base_path}/{version}/sso/certificates?{query}",
8
+ "requestSchema": "schema.json",
9
+ "responseSchema": "schema.json",
10
+ "timeout": 0,
11
+ "sendEmpty": false,
12
+ "requestDatatype": "JSON",
13
+ "responseDatatype": "JSON",
14
+ "headers": {},
15
+ "responseObjects": [
16
+ {
17
+ "type": "default",
18
+ "key": "",
19
+ "mockFile": ""
20
+ }
21
+ ]
22
+ },
23
+ {
24
+ "name": "getSsoIntegrationsIntegrationIdCertificates",
25
+ "protocol": "REST",
26
+ "method": "GET",
27
+ "entitypath": "{base_path}/{version}/sso/integrations/{pathv1}/certificates?{query}",
28
+ "requestSchema": "schema.json",
29
+ "responseSchema": "schema.json",
30
+ "timeout": 0,
31
+ "sendEmpty": false,
32
+ "sendGetBody": false,
33
+ "requestDatatype": "JSON",
34
+ "responseDatatype": "JSON",
35
+ "headers": {},
36
+ "responseObjects": [
37
+ {
38
+ "type": "default",
39
+ "key": "",
40
+ "mockFile": ""
41
+ }
42
+ ]
43
+ },
44
+ {
45
+ "name": "getSsoCertificatesCertId",
46
+ "protocol": "REST",
47
+ "method": "GET",
48
+ "entitypath": "{base_path}/{version}/sso/certificates/{pathv1}?{query}",
49
+ "requestSchema": "schema.json",
50
+ "responseSchema": "schema.json",
51
+ "timeout": 0,
52
+ "sendEmpty": false,
53
+ "sendGetBody": false,
54
+ "requestDatatype": "JSON",
55
+ "responseDatatype": "JSON",
56
+ "headers": {},
57
+ "responseObjects": [
58
+ {
59
+ "type": "default",
60
+ "key": "",
61
+ "mockFile": ""
62
+ }
63
+ ]
64
+ },
65
+ {
66
+ "name": "patchSsoCertificatesCertId",
67
+ "protocol": "REST",
68
+ "method": "PATCH",
69
+ "entitypath": "{base_path}/{version}/sso/certificates/{pathv1}?{query}",
70
+ "requestSchema": "schema.json",
71
+ "responseSchema": "schema.json",
72
+ "timeout": 0,
73
+ "sendEmpty": false,
74
+ "requestDatatype": "JSON",
75
+ "responseDatatype": "JSON",
76
+ "headers": {},
77
+ "responseObjects": [
78
+ {
79
+ "type": "default",
80
+ "key": "",
81
+ "mockFile": ""
82
+ }
83
+ ]
84
+ },
85
+ {
86
+ "name": "deleteSsoCertificatesCertId",
87
+ "protocol": "REST",
88
+ "method": "DELETE",
89
+ "entitypath": "{base_path}/{version}/sso/certificates/{pathv1}?{query}",
90
+ "requestSchema": "schema.json",
91
+ "responseSchema": "schema.json",
92
+ "timeout": 0,
93
+ "sendEmpty": false,
94
+ "requestDatatype": "JSON",
95
+ "responseDatatype": "JSON",
96
+ "headers": {},
97
+ "responseObjects": [
98
+ {
99
+ "type": "default",
100
+ "key": "",
101
+ "mockFile": ""
102
+ }
103
+ ]
104
+ }
105
+ ]
106
+ }
package/entities/Certificates/schema.json ADDED
@@ -0,0 +1,45 @@
1
+ {
2
+ "$id": "schema.json",
3
+ "type": "object",
4
+ "schema": "http://json-schema.org/draft-07/schema#",
5
+ "translate": true,
6
+ "dynamicfields": true,
7
+ "properties": {
8
+ "ph_request_type": {
9
+ "type": "string",
10
+ "description": "type of request (internal to adapter)",
11
+ "default": "postSsoCertificates",
12
+ "enum": [
13
+ "postSsoCertificates",
14
+ "getSsoIntegrationsIntegrationIdCertificates",
15
+ "getSsoCertificatesCertId",
16
+ "patchSsoCertificatesCertId",
17
+ "deleteSsoCertificatesCertId"
18
+ ],
19
+ "external_name": "ph_request_type"
20
+ },
21
+ "integrationId": {
22
+ "type": "string",
23
+ "description": "An ID that matches a certificate to a specific IdP integration.",
24
+ "parse": false,
25
+ "encode": false,
26
+ "encrypt": {
27
+ "type": "AES",
28
+ "key": ""
29
+ },
30
+ "external_name": "integration_id"
31
+ },
32
+ "certId": {
33
+ "type": "string",
34
+ "description": "",
35
+ "parse": false,
36
+ "encode": false,
37
+ "encrypt": {
38
+ "type": "AES",
39
+ "key": ""
40
+ },
41
+ "external_name": "cert_id"
42
+ }
43
+ },
44
+ "definitions": {}
45
+ }
package/entities/Contacts/action.json ADDED
@@ -0,0 +1,270 @@
1
+ {
2
+ "actions": [
3
+ {
4
+ "name": "putMcContacts",
5
+ "protocol": "REST",
6
+ "method": "PUT",
7
+ "entitypath": "{base_path}/{version}/marketing/contacts?{query}",
8
+ "requestSchema": "schema.json",
9
+ "responseSchema": "schema.json",
10
+ "timeout": 0,
11
+ "sendEmpty": false,
12
+ "requestDatatype": "JSON",
13
+ "responseDatatype": "JSON",
14
+ "headers": {},
15
+ "responseObjects": [
16
+ {
17
+ "type": "default",
18
+ "key": "",
19
+ "mockFile": ""
20
+ }
21
+ ]
22
+ },
23
+ {
24
+ "name": "deleteMcContacts",
25
+ "protocol": "REST",
26
+ "method": "DELETE",
27
+ "entitypath": "{base_path}/{version}/marketing/contacts?{query}",
28
+ "requestSchema": "schema.json",
29
+ "responseSchema": "schema.json",
30
+ "timeout": 0,
31
+ "sendEmpty": false,
32
+ "requestDatatype": "JSON",
33
+ "responseDatatype": "JSON",
34
+ "headers": {},
35
+ "responseObjects": [
36
+ {
37
+ "type": "default",
38
+ "key": "",
39
+ "mockFile": ""
40
+ }
41
+ ]
42
+ },
43
+ {
44
+ "name": "getMcContats",
45
+ "protocol": "REST",
46
+ "method": "GET",
47
+ "entitypath": "{base_path}/{version}/marketing/contacts?{query}",
48
+ "requestSchema": "schema.json",
49
+ "responseSchema": "schema.json",
50
+ "timeout": 0,
51
+ "sendEmpty": false,
52
+ "sendGetBody": false,
53
+ "requestDatatype": "JSON",
54
+ "responseDatatype": "JSON",
55
+ "headers": {},
56
+ "responseObjects": [
57
+ {
58
+ "type": "default",
59
+ "key": "",
60
+ "mockFile": ""
61
+ }
62
+ ]
63
+ },
64
+ {
65
+ "name": "getMcContactsCount",
66
+ "protocol": "REST",
67
+ "method": "GET",
68
+ "entitypath": "{base_path}/{version}/marketing/contacts/count?{query}",
69
+ "requestSchema": "schema.json",
70
+ "responseSchema": "schema.json",
71
+ "timeout": 0,
72
+ "sendEmpty": false,
73
+ "sendGetBody": false,
74
+ "requestDatatype": "JSON",
75
+ "responseDatatype": "JSON",
76
+ "headers": {},
77
+ "responseObjects": [
78
+ {
79
+ "type": "default",
80
+ "key": "",
81
+ "mockFile": ""
82
+ }
83
+ ]
84
+ },
85
+ {
86
+ "name": "postMcContactsExports",
87
+ "protocol": "REST",
88
+ "method": "POST",
89
+ "entitypath": "{base_path}/{version}/marketing/contacts/exports?{query}",
90
+ "requestSchema": "schema.json",
91
+ "responseSchema": "schema.json",
92
+ "timeout": 0,
93
+ "sendEmpty": false,
94
+ "requestDatatype": "JSON",
95
+ "responseDatatype": "JSON",
96
+ "headers": {},
97
+ "responseObjects": [
98
+ {
99
+ "type": "default",
100
+ "key": "",
101
+ "mockFile": ""
102
+ }
103
+ ]
104
+ },
105
+ {
106
+ "name": "getMarketingContactsExports",
107
+ "protocol": "REST",
108
+ "method": "GET",
109
+ "entitypath": "{base_path}/{version}/marketing/contacts/exports?{query}",
110
+ "requestSchema": "schema.json",
111
+ "responseSchema": "schema.json",
112
+ "timeout": 0,
113
+ "sendEmpty": false,
114
+ "sendGetBody": false,
115
+ "requestDatatype": "JSON",
116
+ "responseDatatype": "JSON",
117
+ "headers": {},
118
+ "responseObjects": [
119
+ {
120
+ "type": "default",
121
+ "key": "",
122
+ "mockFile": ""
123
+ }
124
+ ]
125
+ },
126
+ {
127
+ "name": "getMcContactsId",
128
+ "protocol": "REST",
129
+ "method": "GET",
130
+ "entitypath": "{base_path}/{version}/marketing/contacts/{pathv1}?{query}",
131
+ "requestSchema": "schema.json",
132
+ "responseSchema": "schema.json",
133
+ "timeout": 0,
134
+ "sendEmpty": false,
135
+ "sendGetBody": false,
136
+ "requestDatatype": "JSON",
137
+ "responseDatatype": "JSON",
138
+ "headers": {},
139
+ "responseObjects": [
140
+ {
141
+ "type": "default",
142
+ "key": "",
143
+ "mockFile": ""
144
+ }
145
+ ]
146
+ },
147
+ {
148
+ "name": "postMcContactsSearch",
149
+ "protocol": "REST",
150
+ "method": "POST",
151
+ "entitypath": "{base_path}/{version}/marketing/contacts/search?{query}",
152
+ "requestSchema": "schema.json",
153
+ "responseSchema": "schema.json",
154
+ "timeout": 0,
155
+ "sendEmpty": false,
156
+ "requestDatatype": "JSON",
157
+ "responseDatatype": "JSON",
158
+ "headers": {},
159
+ "responseObjects": [
160
+ {
161
+ "type": "default",
162
+ "key": "",
163
+ "mockFile": ""
164
+ }
165
+ ]
166
+ },
167
+ {
168
+ "name": "putMcContactsImports",
169
+ "protocol": "REST",
170
+ "method": "PUT",
171
+ "entitypath": "{base_path}/{version}/marketing/contacts/imports?{query}",
172
+ "requestSchema": "schema.json",
173
+ "responseSchema": "schema.json",
174
+ "timeout": 0,
175
+ "sendEmpty": false,
176
+ "requestDatatype": "JSON",
177
+ "responseDatatype": "JSON",
178
+ "headers": {},
179
+ "responseObjects": [
180
+ {
181
+ "type": "default",
182
+ "key": "",
183
+ "mockFile": ""
184
+ }
185
+ ]
186
+ },
187
+ {
188
+ "name": "getMarketingContactsImportsId",
189
+ "protocol": "REST",
190
+ "method": "GET",
191
+ "entitypath": "{base_path}/{version}/marketing/contacts/imports/{pathv1}?{query}",
192
+ "requestSchema": "schema.json",
193
+ "responseSchema": "schema.json",
194
+ "timeout": 0,
195
+ "sendEmpty": false,
196
+ "sendGetBody": false,
197
+ "requestDatatype": "JSON",
198
+ "responseDatatype": "JSON",
199
+ "headers": {},
200
+ "responseObjects": [
201
+ {
202
+ "type": "default",
203
+ "key": "",
204
+ "mockFile": ""
205
+ }
206
+ ]
207
+ },
208
+ {
209
+ "name": "getMcContactsExportsId",
210
+ "protocol": "REST",
211
+ "method": "GET",
212
+ "entitypath": "{base_path}/{version}/marketing/contacts/exports/{pathv1}?{query}",
213
+ "requestSchema": "schema.json",
214
+ "responseSchema": "schema.json",
215
+ "timeout": 0,
216
+ "sendEmpty": false,
217
+ "sendGetBody": false,
218
+ "requestDatatype": "JSON",
219
+ "responseDatatype": "JSON",
220
+ "headers": {},
221
+ "responseObjects": [
222
+ {
223
+ "type": "default",
224
+ "key": "",
225
+ "mockFile": ""
226
+ }
227
+ ]
228
+ },
229
+ {
230
+ "name": "postMarketingContactsBatch",
231
+ "protocol": "REST",
232
+ "method": "POST",
233
+ "entitypath": "{base_path}/{version}/marketing/contacts/batch?{query}",
234
+ "requestSchema": "schema.json",
235
+ "responseSchema": "schema.json",
236
+ "timeout": 0,
237
+ "sendEmpty": false,
238
+ "requestDatatype": "JSON",
239
+ "responseDatatype": "JSON",
240
+ "headers": {},
241
+ "responseObjects": [
242
+ {
243
+ "type": "default",
244
+ "key": "",
245
+ "mockFile": ""
246
+ }
247
+ ]
248
+ },
249
+ {
250
+ "name": "postMarketingContactsSearchEmails",
251
+ "protocol": "REST",
252
+ "method": "POST",
253
+ "entitypath": "{base_path}/{version}/marketing/contacts/search/emails?{query}",
254
+ "requestSchema": "schema.json",
255
+ "responseSchema": "schema.json",
256
+ "timeout": 0,
257
+ "sendEmpty": false,
258
+ "requestDatatype": "JSON",
259
+ "responseDatatype": "JSON",
260
+ "headers": {},
261
+ "responseObjects": [
262
+ {
263
+ "type": "default",
264
+ "key": "",
265
+ "mockFile": ""
266
+ }
267
+ ]
268
+ }
269
+ ]
270
+ }
package/entities/Contacts/schema.json ADDED
@@ -0,0 +1,42 @@
1
+ {
2
+ "$id": "schema.json",
3
+ "type": "object",
4
+ "schema": "http://json-schema.org/draft-07/schema#",
5
+ "translate": true,
6
+ "dynamicfields": true,
7
+ "properties": {
8
+ "ph_request_type": {
9
+ "type": "string",
10
+ "description": "type of request (internal to adapter)",
11
+ "default": "putMcContacts",
12
+ "enum": [
13
+ "putMcContacts",
14
+ "deleteMcContacts",
15
+ "getMcContats",
16
+ "getMcContactsCount",
17
+ "postMcContactsExports",
18
+ "getMarketingContactsExports",
19
+ "getMcContactsId",
20
+ "postMcContactsSearch",
21
+ "putMcContactsImports",
22
+ "getMarketingContactsImportsId",
23
+ "getMcContactsExportsId",
24
+ "postMarketingContactsBatch",
25
+ "postMarketingContactsSearchEmails"
26
+ ],
27
+ "external_name": "ph_request_type"
28
+ },
29
+ "deleteAllContacts": {
30
+ "type": "string",
31
+ "description": "Must be set to `\"true\"` to delete all contacts.",
32
+ "parse": false,
33
+ "encode": false,
34
+ "encrypt": {
35
+ "type": "AES",
36
+ "key": ""
37
+ },
38
+ "external_name": "delete_all_contacts"
39
+ }
40
+ },
41
+ "definitions": {}
42
+ }
package/entities/ContactsAPICustomFields/action.json ADDED
@@ -0,0 +1,107 @@
1
+ {
2
+ "actions": [
3
+ {
4
+ "name": "postContactdbCustomFields",
5
+ "protocol": "REST",
6
+ "method": "POST",
7
+ "entitypath": "{base_path}/{version}/contactdb/custom_fields?{query}",
8
+ "requestSchema": "schema.json",
9
+ "responseSchema": "schema.json",
10
+ "timeout": 0,
11
+ "sendEmpty": false,
12
+ "requestDatatype": "JSON",
13
+ "responseDatatype": "JSON",
14
+ "headers": {},
15
+ "responseObjects": [
16
+ {
17
+ "type": "default",
18
+ "key": "",
19
+ "mockFile": ""
20
+ }
21
+ ]
22
+ },
23
+ {
24
+ "name": "getContactdbCustomFields",
25
+ "protocol": "REST",
26
+ "method": "GET",
27
+ "entitypath": "{base_path}/{version}/contactdb/custom_fields?{query}",
28
+ "requestSchema": "schema.json",
29
+ "responseSchema": "schema.json",
30
+ "timeout": 0,
31
+ "sendEmpty": false,
32
+ "sendGetBody": false,
33
+ "requestDatatype": "JSON",
34
+ "responseDatatype": "JSON",
35
+ "headers": {},
36
+ "responseObjects": [
37
+ {
38
+ "type": "default",
39
+ "key": "",
40
+ "mockFile": ""
41
+ }
42
+ ]
43
+ },
44
+ {
45
+ "name": "getContactdbCustomFieldsCustomFieldId",
46
+ "protocol": "REST",
47
+ "method": "GET",
48
+ "entitypath": "{base_path}/{version}/contactdb/custom_fields/{pathv1}?{query}",
49
+ "requestSchema": "schema.json",
50
+ "responseSchema": "schema.json",
51
+ "timeout": 0,
52
+ "sendEmpty": false,
53
+ "sendGetBody": false,
54
+ "requestDatatype": "JSON",
55
+ "responseDatatype": "JSON",
56
+ "headers": {},
57
+ "responseObjects": [
58
+ {
59
+ "type": "default",
60
+ "key": "",
61
+ "mockFile": ""
62
+ }
63
+ ]
64
+ },
65
+ {
66
+ "name": "deleteContactdbCustomFieldsCustomFieldId",
67
+ "protocol": "REST",
68
+ "method": "DELETE",
69
+ "entitypath": "{base_path}/{version}/contactdb/custom_fields/{pathv1}?{query}",
70
+ "requestSchema": "schema.json",
71
+ "responseSchema": "schema.json",
72
+ "timeout": 0,
73
+ "sendEmpty": false,
74
+ "requestDatatype": "JSON",
75
+ "responseDatatype": "JSON",
76
+ "headers": {},
77
+ "responseObjects": [
78
+ {
79
+ "type": "default",
80
+ "key": "",
81
+ "mockFile": ""
82
+ }
83
+ ]
84
+ },
85
+ {
86
+ "name": "getContactdbReservedFields",
87
+ "protocol": "REST",
88
+ "method": "GET",
89
+ "entitypath": "{base_path}/{version}/contactdb/reserved_fields?{query}",
90
+ "requestSchema": "schema.json",
91
+ "responseSchema": "schema.json",
92
+ "timeout": 0,
93
+ "sendEmpty": false,
94
+ "sendGetBody": false,
95
+ "requestDatatype": "JSON",
96
+ "responseDatatype": "JSON",
97
+ "headers": {},
98
+ "responseObjects": [
99
+ {
100
+ "type": "default",
101
+ "key": "",
102
+ "mockFile": ""
103
+ }
104
+ ]
105
+ }
106
+ ]
107
+ }
package/entities/ContactsAPICustomFields/schema.json ADDED
@@ -0,0 +1,34 @@
1
+ {
2
+ "$id": "schema.json",
3
+ "type": "object",
4
+ "schema": "http://json-schema.org/draft-07/schema#",
5
+ "translate": true,
6
+ "dynamicfields": true,
7
+ "properties": {
8
+ "ph_request_type": {
9
+ "type": "string",
10
+ "description": "type of request (internal to adapter)",
11
+ "default": "postContactdbCustomFields",
12
+ "enum": [
13
+ "postContactdbCustomFields",
14
+ "getContactdbCustomFields",
15
+ "getContactdbCustomFieldsCustomFieldId",
16
+ "deleteContactdbCustomFieldsCustomFieldId",
17
+ "getContactdbReservedFields"
18
+ ],
19
+ "external_name": "ph_request_type"
20
+ },
21
+ "customFieldId": {
22
+ "type": "number",
23
+ "description": "The ID of the custom field that you want to retrieve.",
24
+ "parse": false,
25
+ "encode": false,
26
+ "encrypt": {
27
+ "type": "AES",
28
+ "key": ""
29
+ },
30
+ "external_name": "custom_field_id"
31
+ }
32
+ },
33
+ "definitions": {}
34
+ }