@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/ContactsAPILists/action.json ADDED
@@ -0,0 +1,207 @@
1
+ {
2
+ "actions": [
3
+ {
4
+ "name": "postContactdbLists",
5
+ "protocol": "REST",
6
+ "method": "POST",
7
+ "entitypath": "{base_path}/{version}/contactdb/lists?{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": "getContactdbLists",
25
+ "protocol": "REST",
26
+ "method": "GET",
27
+ "entitypath": "{base_path}/{version}/contactdb/lists?{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": "deleteContactdbLists",
46
+ "protocol": "REST",
47
+ "method": "DELETE",
48
+ "entitypath": "{base_path}/{version}/contactdb/lists?{query}",
49
+ "requestSchema": "schema.json",
50
+ "responseSchema": "schema.json",
51
+ "timeout": 0,
52
+ "sendEmpty": 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": "getContactdbListsListId",
66
+ "protocol": "REST",
67
+ "method": "GET",
68
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}?{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": "patchContactdbListsListId",
87
+ "protocol": "REST",
88
+ "method": "PATCH",
89
+ "entitypath": "{base_path}/{version}/contactdb/lists/{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
+ "name": "deleteContactdbListsListId",
107
+ "protocol": "REST",
108
+ "method": "DELETE",
109
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}?{query}",
110
+ "requestSchema": "schema.json",
111
+ "responseSchema": "schema.json",
112
+ "timeout": 0,
113
+ "sendEmpty": false,
114
+ "requestDatatype": "JSON",
115
+ "responseDatatype": "JSON",
116
+ "headers": {},
117
+ "responseObjects": [
118
+ {
119
+ "type": "default",
120
+ "key": "",
121
+ "mockFile": ""
122
+ }
123
+ ]
124
+ },
125
+ {
126
+ "name": "getContactdbListsListIdRecipients",
127
+ "protocol": "REST",
128
+ "method": "GET",
129
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}/recipients?{query}",
130
+ "requestSchema": "schema.json",
131
+ "responseSchema": "schema.json",
132
+ "timeout": 0,
133
+ "sendEmpty": false,
134
+ "sendGetBody": false,
135
+ "requestDatatype": "JSON",
136
+ "responseDatatype": "JSON",
137
+ "headers": {},
138
+ "responseObjects": [
139
+ {
140
+ "type": "default",
141
+ "key": "",
142
+ "mockFile": ""
143
+ }
144
+ ]
145
+ },
146
+ {
147
+ "name": "postContactdbListsListIdRecipients",
148
+ "protocol": "REST",
149
+ "method": "POST",
150
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}/recipients?{query}",
151
+ "requestSchema": "schema.json",
152
+ "responseSchema": "schema.json",
153
+ "timeout": 0,
154
+ "sendEmpty": false,
155
+ "requestDatatype": "JSON",
156
+ "responseDatatype": "JSON",
157
+ "headers": {},
158
+ "responseObjects": [
159
+ {
160
+ "type": "default",
161
+ "key": "",
162
+ "mockFile": ""
163
+ }
164
+ ]
165
+ },
166
+ {
167
+ "name": "postContactdbListsListIdRecipientsRecipientId",
168
+ "protocol": "REST",
169
+ "method": "POST",
170
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}/recipients/{pathv2}?{query}",
171
+ "requestSchema": "schema.json",
172
+ "responseSchema": "schema.json",
173
+ "timeout": 0,
174
+ "sendEmpty": false,
175
+ "requestDatatype": "JSON",
176
+ "responseDatatype": "JSON",
177
+ "headers": {},
178
+ "responseObjects": [
179
+ {
180
+ "type": "default",
181
+ "key": "",
182
+ "mockFile": ""
183
+ }
184
+ ]
185
+ },
186
+ {
187
+ "name": "deleteContactdbListsListIdRecipientsRecipientId",
188
+ "protocol": "REST",
189
+ "method": "DELETE",
190
+ "entitypath": "{base_path}/{version}/contactdb/lists/{pathv1}/recipients/{pathv2}?{query}",
191
+ "requestSchema": "schema.json",
192
+ "responseSchema": "schema.json",
193
+ "timeout": 0,
194
+ "sendEmpty": false,
195
+ "requestDatatype": "JSON",
196
+ "responseDatatype": "JSON",
197
+ "headers": {},
198
+ "responseObjects": [
199
+ {
200
+ "type": "default",
201
+ "key": "",
202
+ "mockFile": ""
203
+ }
204
+ ]
205
+ }
206
+ ]
207
+ }
package/entities/ContactsAPILists/schema.json ADDED
@@ -0,0 +1,72 @@
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": "postContactdbLists",
12
+ "enum": [
13
+ "postContactdbLists",
14
+ "getContactdbLists",
15
+ "deleteContactdbLists",
16
+ "getContactdbListsListId",
17
+ "patchContactdbListsListId",
18
+ "deleteContactdbListsListId",
19
+ "getContactdbListsListIdRecipients",
20
+ "postContactdbListsListIdRecipients",
21
+ "postContactdbListsListIdRecipientsRecipientId",
22
+ "deleteContactdbListsListIdRecipientsRecipientId"
23
+ ],
24
+ "external_name": "ph_request_type"
25
+ },
26
+ "listId": {
27
+ "type": ["number", "string"],
28
+ "description": "The ID of the list you are taking this recipient away from.",
29
+ "parse": false,
30
+ "encode": false,
31
+ "encrypt": {
32
+ "type": "AES",
33
+ "key": ""
34
+ },
35
+ "external_name": "list_id"
36
+ },
37
+ "deleteContacts": {
38
+ "type": "boolean",
39
+ "description": "Adds the ability to delete all contacts on the list in addition to deleting the list.",
40
+ "parse": false,
41
+ "encode": false,
42
+ "encrypt": {
43
+ "type": "AES",
44
+ "key": ""
45
+ },
46
+ "external_name": "delete_contacts"
47
+ },
48
+ "pageSize": {
49
+ "type": "number",
50
+ "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)",
51
+ "parse": false,
52
+ "encode": false,
53
+ "encrypt": {
54
+ "type": "AES",
55
+ "key": ""
56
+ },
57
+ "external_name": "page_size"
58
+ },
59
+ "recipientId": {
60
+ "type": ["number", "string"],
61
+ "description": "The ID of the recipient to take off the list.",
62
+ "parse": false,
63
+ "encode": false,
64
+ "encrypt": {
65
+ "type": "AES",
66
+ "key": ""
67
+ },
68
+ "external_name": "recipient_id"
69
+ }
70
+ },
71
+ "definitions": {}
72
+ }
package/entities/ContactsAPIRecipients/action.json ADDED
@@ -0,0 +1,251 @@
1
+ {
2
+ "actions": [
3
+ {
4
+ "name": "postContactdbRecipients",
5
+ "protocol": "REST",
6
+ "method": "POST",
7
+ "entitypath": "{base_path}/{version}/contactdb/recipients?{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": "patchContactdbRecipients",
25
+ "protocol": "REST",
26
+ "method": "PATCH",
27
+ "entitypath": "{base_path}/{version}/contactdb/recipients?{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": "deleteContactdbRecipients",
45
+ "protocol": "REST",
46
+ "method": "DELETE",
47
+ "entitypath": "{base_path}/{version}/contactdb/recipients?{query}",
48
+ "requestSchema": "schema.json",
49
+ "responseSchema": "schema.json",
50
+ "timeout": 0,
51
+ "sendEmpty": false,
52
+ "requestDatatype": "JSON",
53
+ "responseDatatype": "JSON",
54
+ "headers": {},
55
+ "responseObjects": [
56
+ {
57
+ "type": "default",
58
+ "key": "",
59
+ "mockFile": ""
60
+ }
61
+ ]
62
+ },
63
+ {
64
+ "name": "getContactdbRecipients",
65
+ "protocol": "REST",
66
+ "method": "GET",
67
+ "entitypath": "{base_path}/{version}/contactdb/recipients?{query}",
68
+ "requestSchema": "schema.json",
69
+ "responseSchema": "schema.json",
70
+ "timeout": 0,
71
+ "sendEmpty": false,
72
+ "sendGetBody": false,
73
+ "requestDatatype": "JSON",
74
+ "responseDatatype": "JSON",
75
+ "headers": {},
76
+ "responseObjects": [
77
+ {
78
+ "type": "default",
79
+ "key": "",
80
+ "mockFile": ""
81
+ }
82
+ ]
83
+ },
84
+ {
85
+ "name": "getContactdbStatus",
86
+ "protocol": "REST",
87
+ "method": "GET",
88
+ "entitypath": "{base_path}/{version}/contactdb/status?{query}",
89
+ "requestSchema": "schema.json",
90
+ "responseSchema": "schema.json",
91
+ "timeout": 0,
92
+ "sendEmpty": false,
93
+ "sendGetBody": 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": "getContactdbRecipientsRecipientId",
107
+ "protocol": "REST",
108
+ "method": "GET",
109
+ "entitypath": "{base_path}/{version}/contactdb/recipients/{pathv1}?{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": "deleteContactdbRecipientsRecipientId",
128
+ "protocol": "REST",
129
+ "method": "DELETE",
130
+ "entitypath": "{base_path}/{version}/contactdb/recipients/{pathv1}?{query}",
131
+ "requestSchema": "schema.json",
132
+ "responseSchema": "schema.json",
133
+ "timeout": 0,
134
+ "sendEmpty": false,
135
+ "requestDatatype": "JSON",
136
+ "responseDatatype": "JSON",
137
+ "headers": {},
138
+ "responseObjects": [
139
+ {
140
+ "type": "default",
141
+ "key": "",
142
+ "mockFile": ""
143
+ }
144
+ ]
145
+ },
146
+ {
147
+ "name": "getContactdbRecipientsRecipientIdLists",
148
+ "protocol": "REST",
149
+ "method": "GET",
150
+ "entitypath": "{base_path}/{version}/contactdb/recipients/{pathv1}/lists?{query}",
151
+ "requestSchema": "schema.json",
152
+ "responseSchema": "schema.json",
153
+ "timeout": 0,
154
+ "sendEmpty": false,
155
+ "sendGetBody": 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": "getContactdbRecipientsBillableCount",
169
+ "protocol": "REST",
170
+ "method": "GET",
171
+ "entitypath": "{base_path}/{version}/contactdb/recipients/billable_count?{query}",
172
+ "requestSchema": "schema.json",
173
+ "responseSchema": "schema.json",
174
+ "timeout": 0,
175
+ "sendEmpty": false,
176
+ "sendGetBody": false,
177
+ "requestDatatype": "JSON",
178
+ "responseDatatype": "JSON",
179
+ "headers": {},
180
+ "responseObjects": [
181
+ {
182
+ "type": "default",
183
+ "key": "",
184
+ "mockFile": ""
185
+ }
186
+ ]
187
+ },
188
+ {
189
+ "name": "getContactdbRecipientsCount",
190
+ "protocol": "REST",
191
+ "method": "GET",
192
+ "entitypath": "{base_path}/{version}/contactdb/recipients/count?{query}",
193
+ "requestSchema": "schema.json",
194
+ "responseSchema": "schema.json",
195
+ "timeout": 0,
196
+ "sendEmpty": false,
197
+ "sendGetBody": false,
198
+ "requestDatatype": "JSON",
199
+ "responseDatatype": "JSON",
200
+ "headers": {},
201
+ "responseObjects": [
202
+ {
203
+ "type": "default",
204
+ "key": "",
205
+ "mockFile": ""
206
+ }
207
+ ]
208
+ },
209
+ {
210
+ "name": "getContactdbRecipientsSearch",
211
+ "protocol": "REST",
212
+ "method": "GET",
213
+ "entitypath": "{base_path}/{version}/contactdb/recipients/search?{query}",
214
+ "requestSchema": "schema.json",
215
+ "responseSchema": "schema.json",
216
+ "timeout": 0,
217
+ "sendEmpty": false,
218
+ "sendGetBody": false,
219
+ "requestDatatype": "JSON",
220
+ "responseDatatype": "JSON",
221
+ "headers": {},
222
+ "responseObjects": [
223
+ {
224
+ "type": "default",
225
+ "key": "",
226
+ "mockFile": ""
227
+ }
228
+ ]
229
+ },
230
+ {
231
+ "name": "postContactdbRecipientsSearch",
232
+ "protocol": "REST",
233
+ "method": "POST",
234
+ "entitypath": "{base_path}/{version}/contactdb/recipients/search?{query}",
235
+ "requestSchema": "schema.json",
236
+ "responseSchema": "schema.json",
237
+ "timeout": 0,
238
+ "sendEmpty": false,
239
+ "requestDatatype": "JSON",
240
+ "responseDatatype": "JSON",
241
+ "headers": {},
242
+ "responseObjects": [
243
+ {
244
+ "type": "default",
245
+ "key": "",
246
+ "mockFile": ""
247
+ }
248
+ ]
249
+ }
250
+ ]
251
+ }
package/entities/ContactsAPIRecipients/schema.json ADDED
@@ -0,0 +1,63 @@
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": "postContactdbRecipients",
12
+ "enum": [
13
+ "postContactdbRecipients",
14
+ "patchContactdbRecipients",
15
+ "deleteContactdbRecipients",
16
+ "getContactdbRecipients",
17
+ "getContactdbStatus",
18
+ "getContactdbRecipientsRecipientId",
19
+ "deleteContactdbRecipientsRecipientId",
20
+ "getContactdbRecipientsRecipientIdLists",
21
+ "getContactdbRecipientsBillableCount",
22
+ "getContactdbRecipientsCount",
23
+ "getContactdbRecipientsSearch",
24
+ "postContactdbRecipientsSearch"
25
+ ],
26
+ "external_name": "ph_request_type"
27
+ },
28
+ "pageSize": {
29
+ "type": "number",
30
+ "description": "Number of recipients to return at a time (must be a positive integer between 1 and 1000)",
31
+ "parse": false,
32
+ "encode": false,
33
+ "encrypt": {
34
+ "type": "AES",
35
+ "key": ""
36
+ },
37
+ "external_name": "page_size"
38
+ },
39
+ "recipientId": {
40
+ "type": "string",
41
+ "description": "The ID of the recipient for whom you are retrieving lists.",
42
+ "parse": false,
43
+ "encode": false,
44
+ "encrypt": {
45
+ "type": "AES",
46
+ "key": ""
47
+ },
48
+ "external_name": "recipient_id"
49
+ },
50
+ "fieldName": {
51
+ "type": "string",
52
+ "description": "",
53
+ "parse": false,
54
+ "encode": false,
55
+ "encrypt": {
56
+ "type": "AES",
57
+ "key": ""
58
+ },
59
+ "external_name": "{field_name}"
60
+ }
61
+ },
62
+ "definitions": {}
63
+ }