@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/CALLS.md ADDED
@@ -0,0 +1,2211 @@
1
+ ## Using this Adapter
2
+
3
+ The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
4
+
5
+ ### Generic Adapter Calls
6
+
7
+ These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
8
+
9
+ <table border="1" class="bordered-table">
10
+ <tr>
11
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
12
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
13
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
14
+ </tr>
15
+ <tr>
16
+ <td style="padding:15px">connect()</td>
17
+ <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
18
+ <td style="padding:15px">No</td>
19
+ </tr>
20
+ <tr>
21
+ <td style="padding:15px">healthCheck(callback)</td>
22
+ <td style="padding:15px">This call ensures that the adapter can communicate with Sendgrid. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
23
+ <td style="padding:15px">No</td>
24
+ </tr>
25
+ <tr>
26
+ <td style="padding:15px">refreshProperties(properties)</td>
27
+ <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
28
+ <td style="padding:15px">No</td>
29
+ </tr>
30
+ <tr>
31
+ <td style="padding:15px">encryptProperty(property, technique, callback)</td>
32
+ <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Sendgrid.</td>
33
+ <td style="padding:15px">No</td>
34
+ </tr>
35
+ <tr>
36
+ <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
37
+ <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
38
+ <td style="padding:15px">Yes</td>
39
+ </tr>
40
+ <tr>
41
+ <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
42
+ <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
43
+ <td style="padding:15px">Yes</td>
44
+ </tr>
45
+ <tr>
46
+ <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
47
+ <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
48
+ <td style="padding:15px">Yes</td>
49
+ </tr>
50
+ <tr>
51
+ <td style="padding:15px">iapGetAdapterQueue(callback)</td>
52
+ <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
53
+ <td style="padding:15px">Yes</td>
54
+ </tr>
55
+ <tr>
56
+ <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
57
+ <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
58
+ <td style="padding:15px">Yes</td>
59
+ </tr>
60
+ <tr>
61
+ <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
62
+ <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
63
+ <td style="padding:15px">Yes</td>
64
+ </tr>
65
+ <tr>
66
+ <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
67
+ <td style="padding:15px">This call will return the results of a healthcheck.</td>
68
+ <td style="padding:15px">Yes</td>
69
+ </tr>
70
+ <tr>
71
+ <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
72
+ <td style="padding:15px">This call will return the results of a connectivity check.</td>
73
+ <td style="padding:15px">Yes</td>
74
+ </tr>
75
+ <tr>
76
+ <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
77
+ <td style="padding:15px">This call will return the results of running basic get API calls.</td>
78
+ <td style="padding:15px">Yes</td>
79
+ </tr>
80
+ <tr>
81
+ <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
82
+ <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
83
+ <td style="padding:15px">Yes</td>
84
+ </tr>
85
+ <tr>
86
+ <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
87
+ <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
88
+ <td style="padding:15px">Yes</td>
89
+ </tr>
90
+ <tr>
91
+ <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
92
+ <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
93
+ <td style="padding:15px">Yes</td>
94
+ </tr>
95
+ <tr>
96
+ <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
97
+ <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
98
+ <td style="padding:15px">Yes</td>
99
+ </tr>
100
+ <tr>
101
+ <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
102
+ <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
103
+ <td style="padding:15px">Yes</td>
104
+ </tr>
105
+ <tr>
106
+ <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
107
+ <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
108
+ <td style="padding:15px">Yes</td>
109
+ </tr>
110
+ <tr>
111
+ <td style="padding:15px">iapRunAdapterLint(callback)</td>
112
+ <td style="padding:15px">Runs lint on the adapter and provides the information back.</td>
113
+ <td style="padding:15px">Yes</td>
114
+ </tr>
115
+ <tr>
116
+ <td style="padding:15px">iapRunAdapterTests(callback)</td>
117
+ <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
118
+ <td style="padding:15px">Yes</td>
119
+ </tr>
120
+ <tr>
121
+ <td style="padding:15px">iapGetAdapterInventory(callback)</td>
122
+ <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
123
+ <td style="padding:15px">Yes</td>
124
+ </tr>
125
+ </table>
126
+ <br>
127
+
128
+ ### Adapter Cache Calls
129
+
130
+ These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
131
+
132
+ <table border="1" class="bordered-table">
133
+ <tr>
134
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
135
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
136
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
137
+ </tr>
138
+ <tr>
139
+ <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
140
+ <td style="padding:15px">This call populates the adapter cache.</td>
141
+ <td style="padding:15px">Yes</td>
142
+ </tr>
143
+ <tr>
144
+ <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
145
+ <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
146
+ <td style="padding:15px">Yes</td>
147
+ </tr>
148
+ </table>
149
+ <br>
150
+
151
+ ### Adapter Broker Calls
152
+
153
+ These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
154
+
155
+ <table border="1" class="bordered-table">
156
+ <tr>
157
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
158
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
159
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
160
+ </tr>
161
+ <tr>
162
+ <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
163
+ <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
164
+ <td style="padding:15px">No</td>
165
+ </tr>
166
+ <tr>
167
+ <td style="padding:15px">getDevice(deviceName, callback)</td>
168
+ <td style="padding:15px">This call returns the details of the requested device.</td>
169
+ <td style="padding:15px">No</td>
170
+ </tr>
171
+ <tr>
172
+ <td style="padding:15px">getDevicesFiltered(options, callback)</td>
173
+ <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
174
+ <td style="padding:15px">No</td>
175
+ </tr>
176
+ <tr>
177
+ <td style="padding:15px">isAlive(deviceName, callback)</td>
178
+ <td style="padding:15px">This call returns whether the device status is active</td>
179
+ <td style="padding:15px">No</td>
180
+ </tr>
181
+ <tr>
182
+ <td style="padding:15px">getConfig(deviceName, format, callback)</td>
183
+ <td style="padding:15px">This call returns the configuration for the selected device.</td>
184
+ <td style="padding:15px">No</td>
185
+ </tr>
186
+ <tr>
187
+ <td style="padding:15px">iapGetDeviceCount(callback)</td>
188
+ <td style="padding:15px">This call returns the count of devices.</td>
189
+ <td style="padding:15px">No</td>
190
+ </tr>
191
+ </table>
192
+ <br>
193
+
194
+
195
+ ### Specific Adapter Calls
196
+
197
+ Specific adapter calls are built based on the API of the Sendgrid. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
198
+
199
+ <table border="1" class="bordered-table">
200
+ <tr>
201
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
202
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
203
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
204
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
205
+ </tr>
206
+ <tr>
207
+ <td style="padding:15px">postMailSend(body, iapMetadata, callback)</td>
208
+ <td style="padding:15px">v3 Mail Send</td>
209
+ <td style="padding:15px">{base_path}/{version}/mail/send?{query}</td>
210
+ <td style="padding:15px">Yes</td>
211
+ </tr>
212
+ <tr>
213
+ <td style="padding:15px">postMailBatch(iapMetadata, callback)</td>
214
+ <td style="padding:15px">Create a batch ID</td>
215
+ <td style="padding:15px">{base_path}/{version}/mail/batch?{query}</td>
216
+ <td style="padding:15px">Yes</td>
217
+ </tr>
218
+ <tr>
219
+ <td style="padding:15px">postUserScheduledSends(body, iapMetadata, callback)</td>
220
+ <td style="padding:15px">Cancel or pause a scheduled send</td>
221
+ <td style="padding:15px">{base_path}/{version}/user/scheduled_sends?{query}</td>
222
+ <td style="padding:15px">Yes</td>
223
+ </tr>
224
+ <tr>
225
+ <td style="padding:15px">getUserScheduledSends(iapMetadata, callback)</td>
226
+ <td style="padding:15px">Retrieve all scheduled sends</td>
227
+ <td style="padding:15px">{base_path}/{version}/user/scheduled_sends?{query}</td>
228
+ <td style="padding:15px">Yes</td>
229
+ </tr>
230
+ <tr>
231
+ <td style="padding:15px">getMailBatchBatchId(batchId, iapMetadata, callback)</td>
232
+ <td style="padding:15px">Validate batch ID</td>
233
+ <td style="padding:15px">{base_path}/{version}/mail/batch/{pathv1}?{query}</td>
234
+ <td style="padding:15px">Yes</td>
235
+ </tr>
236
+ <tr>
237
+ <td style="padding:15px">getUserScheduledSendsBatchId(batchId, iapMetadata, callback)</td>
238
+ <td style="padding:15px">Retrieve scheduled send</td>
239
+ <td style="padding:15px">{base_path}/{version}/user/scheduled_sends/{pathv1}?{query}</td>
240
+ <td style="padding:15px">Yes</td>
241
+ </tr>
242
+ <tr>
243
+ <td style="padding:15px">patchUserScheduledSendsBatchId(batchId, body, iapMetadata, callback)</td>
244
+ <td style="padding:15px">Update a scheduled send</td>
245
+ <td style="padding:15px">{base_path}/{version}/user/scheduled_sends/{pathv1}?{query}</td>
246
+ <td style="padding:15px">Yes</td>
247
+ </tr>
248
+ <tr>
249
+ <td style="padding:15px">deleteUserScheduledSendsBatchId(batchId, iapMetadata, callback)</td>
250
+ <td style="padding:15px">Delete a cancellation or pause from a scheduled send</td>
251
+ <td style="padding:15px">{base_path}/{version}/user/scheduled_sends/{pathv1}?{query}</td>
252
+ <td style="padding:15px">Yes</td>
253
+ </tr>
254
+ <tr>
255
+ <td style="padding:15px">createApiKeys(body, iapMetadata, callback)</td>
256
+ <td style="padding:15px">Create API keys</td>
257
+ <td style="padding:15px">{base_path}/{version}/api_keys?{query}</td>
258
+ <td style="padding:15px">Yes</td>
259
+ </tr>
260
+ <tr>
261
+ <td style="padding:15px">getApiKeys(limit, iapMetadata, callback)</td>
262
+ <td style="padding:15px">Retrieve all API Keys belonging to the authenticated user</td>
263
+ <td style="padding:15px">{base_path}/{version}/api_keys?{query}</td>
264
+ <td style="padding:15px">Yes</td>
265
+ </tr>
266
+ <tr>
267
+ <td style="padding:15px">getApiKeysApiKeyId(apiKeyId, iapMetadata, callback)</td>
268
+ <td style="padding:15px">Retrieve an existing API Key</td>
269
+ <td style="padding:15px">{base_path}/{version}/api_keys/{pathv1}?{query}</td>
270
+ <td style="padding:15px">Yes</td>
271
+ </tr>
272
+ <tr>
273
+ <td style="padding:15px">patchApiKeysApiKeyId(apiKeyId, body, iapMetadata, callback)</td>
274
+ <td style="padding:15px">Update API key name</td>
275
+ <td style="padding:15px">{base_path}/{version}/api_keys/{pathv1}?{query}</td>
276
+ <td style="padding:15px">Yes</td>
277
+ </tr>
278
+ <tr>
279
+ <td style="padding:15px">putApiKeysApiKeyId(apiKeyId, body, iapMetadata, callback)</td>
280
+ <td style="padding:15px">Update API key name and scopes</td>
281
+ <td style="padding:15px">{base_path}/{version}/api_keys/{pathv1}?{query}</td>
282
+ <td style="padding:15px">Yes</td>
283
+ </tr>
284
+ <tr>
285
+ <td style="padding:15px">deleteApiKeysApiKeyId(apiKeyId, iapMetadata, callback)</td>
286
+ <td style="padding:15px">Delete API keys</td>
287
+ <td style="padding:15px">{base_path}/{version}/api_keys/{pathv1}?{query}</td>
288
+ <td style="padding:15px">Yes</td>
289
+ </tr>
290
+ <tr>
291
+ <td style="padding:15px">getScopes(iapMetadata, callback)</td>
292
+ <td style="padding:15px">Retrieve a list of scopes for which this user has access.</td>
293
+ <td style="padding:15px">{base_path}/{version}/scopes?{query}</td>
294
+ <td style="padding:15px">Yes</td>
295
+ </tr>
296
+ <tr>
297
+ <td style="padding:15px">getUserSettingsEnforcedTls(iapMetadata, callback)</td>
298
+ <td style="padding:15px">Retrieve current Enforced TLS settings.</td>
299
+ <td style="padding:15px">{base_path}/{version}/user/settings/enforced_tls?{query}</td>
300
+ <td style="padding:15px">Yes</td>
301
+ </tr>
302
+ <tr>
303
+ <td style="padding:15px">patchUserSettingsEnforcedTls(body, iapMetadata, callback)</td>
304
+ <td style="padding:15px">Update Enforced TLS settings</td>
305
+ <td style="padding:15px">{base_path}/{version}/user/settings/enforced_tls?{query}</td>
306
+ <td style="padding:15px">Yes</td>
307
+ </tr>
308
+ <tr>
309
+ <td style="padding:15px">postAccessSettingsWhitelist(body, iapMetadata, callback)</td>
310
+ <td style="padding:15px">Add one or more IPs to the allow list</td>
311
+ <td style="padding:15px">{base_path}/{version}/access_settings/whitelist?{query}</td>
312
+ <td style="padding:15px">Yes</td>
313
+ </tr>
314
+ <tr>
315
+ <td style="padding:15px">getAccessSettingsWhitelist(iapMetadata, callback)</td>
316
+ <td style="padding:15px">Retrieve a list of currently allowed IPs</td>
317
+ <td style="padding:15px">{base_path}/{version}/access_settings/whitelist?{query}</td>
318
+ <td style="padding:15px">Yes</td>
319
+ </tr>
320
+ <tr>
321
+ <td style="padding:15px">deleteAccessSettingsWhitelist(body, iapMetadata, callback)</td>
322
+ <td style="padding:15px">Remove one or more IPs from the allow list</td>
323
+ <td style="padding:15px">{base_path}/{version}/access_settings/whitelist?{query}</td>
324
+ <td style="padding:15px">Yes</td>
325
+ </tr>
326
+ <tr>
327
+ <td style="padding:15px">getAccessSettingsActivity(limit, iapMetadata, callback)</td>
328
+ <td style="padding:15px">Retrieve all recent access attempts</td>
329
+ <td style="padding:15px">{base_path}/{version}/access_settings/activity?{query}</td>
330
+ <td style="padding:15px">Yes</td>
331
+ </tr>
332
+ <tr>
333
+ <td style="padding:15px">getAccessSettingsWhitelistRuleId(ruleId, iapMetadata, callback)</td>
334
+ <td style="padding:15px">Retrieve a specific allowed IP</td>
335
+ <td style="padding:15px">{base_path}/{version}/access_settings/whitelist/{pathv1}?{query}</td>
336
+ <td style="padding:15px">Yes</td>
337
+ </tr>
338
+ <tr>
339
+ <td style="padding:15px">deleteAccessSettingsWhitelistRuleId(ruleId, iapMetadata, callback)</td>
340
+ <td style="padding:15px">Remove a specific IP from the allowed list</td>
341
+ <td style="padding:15px">{base_path}/{version}/access_settings/whitelist/{pathv1}?{query}</td>
342
+ <td style="padding:15px">Yes</td>
343
+ </tr>
344
+ <tr>
345
+ <td style="padding:15px">postSsoCertificates(body, iapMetadata, callback)</td>
346
+ <td style="padding:15px">Create an SSO Certificate</td>
347
+ <td style="padding:15px">{base_path}/{version}/sso/certificates?{query}</td>
348
+ <td style="padding:15px">Yes</td>
349
+ </tr>
350
+ <tr>
351
+ <td style="padding:15px">getSsoIntegrationsIntegrationIdCertificates(integrationId, iapMetadata, callback)</td>
352
+ <td style="padding:15px">Get All SSO Certificates by Integration</td>
353
+ <td style="padding:15px">{base_path}/{version}/sso/integrations/{pathv1}/certificates?{query}</td>
354
+ <td style="padding:15px">Yes</td>
355
+ </tr>
356
+ <tr>
357
+ <td style="padding:15px">getSsoCertificatesCertId(certId, iapMetadata, callback)</td>
358
+ <td style="padding:15px">Get an SSO Certificate</td>
359
+ <td style="padding:15px">{base_path}/{version}/sso/certificates/{pathv1}?{query}</td>
360
+ <td style="padding:15px">Yes</td>
361
+ </tr>
362
+ <tr>
363
+ <td style="padding:15px">patchSsoCertificatesCertId(certId, body, iapMetadata, callback)</td>
364
+ <td style="padding:15px">Update SSO Certificate</td>
365
+ <td style="padding:15px">{base_path}/{version}/sso/certificates/{pathv1}?{query}</td>
366
+ <td style="padding:15px">Yes</td>
367
+ </tr>
368
+ <tr>
369
+ <td style="padding:15px">deleteSsoCertificatesCertId(certId, iapMetadata, callback)</td>
370
+ <td style="padding:15px">Delete an SSO Certificate</td>
371
+ <td style="padding:15px">{base_path}/{version}/sso/certificates/{pathv1}?{query}</td>
372
+ <td style="padding:15px">Yes</td>
373
+ </tr>
374
+ <tr>
375
+ <td style="padding:15px">postSsoIntegrations(body, iapMetadata, callback)</td>
376
+ <td style="padding:15px">Create an SSO Integration</td>
377
+ <td style="padding:15px">{base_path}/{version}/sso/integrations?{query}</td>
378
+ <td style="padding:15px">Yes</td>
379
+ </tr>
380
+ <tr>
381
+ <td style="padding:15px">getSsoIntegrations(si, iapMetadata, callback)</td>
382
+ <td style="padding:15px">Get All SSO Integrations</td>
383
+ <td style="padding:15px">{base_path}/{version}/sso/integrations?{query}</td>
384
+ <td style="padding:15px">Yes</td>
385
+ </tr>
386
+ <tr>
387
+ <td style="padding:15px">getSsoIntegrationsId(id, si, iapMetadata, callback)</td>
388
+ <td style="padding:15px">Get an SSO Integration</td>
389
+ <td style="padding:15px">{base_path}/{version}/sso/integrations/{pathv1}?{query}</td>
390
+ <td style="padding:15px">Yes</td>
391
+ </tr>
392
+ <tr>
393
+ <td style="padding:15px">patchSsoIntegrationsId(id, si, body, iapMetadata, callback)</td>
394
+ <td style="padding:15px">Update an SSO Integration</td>
395
+ <td style="padding:15px">{base_path}/{version}/sso/integrations/{pathv1}?{query}</td>
396
+ <td style="padding:15px">Yes</td>
397
+ </tr>
398
+ <tr>
399
+ <td style="padding:15px">deleteSsoIntegrationsId(id, iapMetadata, callback)</td>
400
+ <td style="padding:15px">Delete an SSO Integration</td>
401
+ <td style="padding:15px">{base_path}/{version}/sso/integrations/{pathv1}?{query}</td>
402
+ <td style="padding:15px">Yes</td>
403
+ </tr>
404
+ <tr>
405
+ <td style="padding:15px">postSsoTeammates(body, iapMetadata, callback)</td>
406
+ <td style="padding:15px">Create SSO Teammate</td>
407
+ <td style="padding:15px">{base_path}/{version}/sso/teammates?{query}</td>
408
+ <td style="padding:15px">Yes</td>
409
+ </tr>
410
+ <tr>
411
+ <td style="padding:15px">patchSsoTeammatesUsername(username, body, iapMetadata, callback)</td>
412
+ <td style="padding:15px">Edit an SSO Teammate</td>
413
+ <td style="padding:15px">{base_path}/{version}/sso/teammates/{pathv1}?{query}</td>
414
+ <td style="padding:15px">Yes</td>
415
+ </tr>
416
+ <tr>
417
+ <td style="padding:15px">getMailSettings(limit, offset, iapMetadata, callback)</td>
418
+ <td style="padding:15px">Retrieve all mail settings</td>
419
+ <td style="padding:15px">{base_path}/{version}/mail_settings?{query}</td>
420
+ <td style="padding:15px">Yes</td>
421
+ </tr>
422
+ <tr>
423
+ <td style="padding:15px">patchMailSettingsAddressWhitelist(body, iapMetadata, callback)</td>
424
+ <td style="padding:15px">Update address whitelist mail settings</td>
425
+ <td style="padding:15px">{base_path}/{version}/mail_settings/address_whitelist?{query}</td>
426
+ <td style="padding:15px">Yes</td>
427
+ </tr>
428
+ <tr>
429
+ <td style="padding:15px">getMailSettingsAddressWhitelist(iapMetadata, callback)</td>
430
+ <td style="padding:15px">Retrieve address whitelist mail settings</td>
431
+ <td style="padding:15px">{base_path}/{version}/mail_settings/address_whitelist?{query}</td>
432
+ <td style="padding:15px">Yes</td>
433
+ </tr>
434
+ <tr>
435
+ <td style="padding:15px">patchMailSettingsFooter(body, iapMetadata, callback)</td>
436
+ <td style="padding:15px">Update footer mail settings</td>
437
+ <td style="padding:15px">{base_path}/{version}/mail_settings/footer?{query}</td>
438
+ <td style="padding:15px">Yes</td>
439
+ </tr>
440
+ <tr>
441
+ <td style="padding:15px">getMailSettingsFooter(iapMetadata, callback)</td>
442
+ <td style="padding:15px">Retrieve footer mail settings</td>
443
+ <td style="padding:15px">{base_path}/{version}/mail_settings/footer?{query}</td>
444
+ <td style="padding:15px">Yes</td>
445
+ </tr>
446
+ <tr>
447
+ <td style="padding:15px">patchMailSettingsForwardSpam(body, iapMetadata, callback)</td>
448
+ <td style="padding:15px">Update forward spam mail settings</td>
449
+ <td style="padding:15px">{base_path}/{version}/mail_settings/forward_spam?{query}</td>
450
+ <td style="padding:15px">Yes</td>
451
+ </tr>
452
+ <tr>
453
+ <td style="padding:15px">getMailSettingsForwardSpam(iapMetadata, callback)</td>
454
+ <td style="padding:15px">Retrieve forward spam mail settings</td>
455
+ <td style="padding:15px">{base_path}/{version}/mail_settings/forward_spam?{query}</td>
456
+ <td style="padding:15px">Yes</td>
457
+ </tr>
458
+ <tr>
459
+ <td style="padding:15px">patchMailSettingsTemplate(body, iapMetadata, callback)</td>
460
+ <td style="padding:15px">Update template mail settings</td>
461
+ <td style="padding:15px">{base_path}/{version}/mail_settings/template?{query}</td>
462
+ <td style="padding:15px">Yes</td>
463
+ </tr>
464
+ <tr>
465
+ <td style="padding:15px">getMailSettingsTemplate(iapMetadata, callback)</td>
466
+ <td style="padding:15px">Retrieve legacy template mail settings</td>
467
+ <td style="padding:15px">{base_path}/{version}/mail_settings/template?{query}</td>
468
+ <td style="padding:15px">Yes</td>
469
+ </tr>
470
+ <tr>
471
+ <td style="padding:15px">patchMailSettingsBouncePurge(body, iapMetadata, callback)</td>
472
+ <td style="padding:15px">Update bounce purge mail settings</td>
473
+ <td style="padding:15px">{base_path}/{version}/mail_settings/bounce_purge?{query}</td>
474
+ <td style="padding:15px">Yes</td>
475
+ </tr>
476
+ <tr>
477
+ <td style="padding:15px">getMailSettingsBouncePurge(iapMetadata, callback)</td>
478
+ <td style="padding:15px">Retrieve bounce purge mail settings</td>
479
+ <td style="padding:15px">{base_path}/{version}/mail_settings/bounce_purge?{query}</td>
480
+ <td style="padding:15px">Yes</td>
481
+ </tr>
482
+ <tr>
483
+ <td style="padding:15px">patchMailSettingsForwardBounce(body, iapMetadata, callback)</td>
484
+ <td style="padding:15px">Update forward bounce mail settings</td>
485
+ <td style="padding:15px">{base_path}/{version}/mail_settings/forward_bounce?{query}</td>
486
+ <td style="padding:15px">Yes</td>
487
+ </tr>
488
+ <tr>
489
+ <td style="padding:15px">getMailSettingsForwardBounce(iapMetadata, callback)</td>
490
+ <td style="padding:15px">Retrieve forward bounce mail settings</td>
491
+ <td style="padding:15px">{base_path}/{version}/mail_settings/forward_bounce?{query}</td>
492
+ <td style="padding:15px">Yes</td>
493
+ </tr>
494
+ <tr>
495
+ <td style="padding:15px">patchPartnerSettingsNewRelic(body, iapMetadata, callback)</td>
496
+ <td style="padding:15px">Updates New Relic partner settings.</td>
497
+ <td style="padding:15px">{base_path}/{version}/partner_settings/new_relic?{query}</td>
498
+ <td style="padding:15px">Yes</td>
499
+ </tr>
500
+ <tr>
501
+ <td style="padding:15px">getPartnerSettingsNewRelic(iapMetadata, callback)</td>
502
+ <td style="padding:15px">Returns all New Relic partner settings.</td>
503
+ <td style="padding:15px">{base_path}/{version}/partner_settings/new_relic?{query}</td>
504
+ <td style="padding:15px">Yes</td>
505
+ </tr>
506
+ <tr>
507
+ <td style="padding:15px">getPartnerSettings(limit, offset, iapMetadata, callback)</td>
508
+ <td style="padding:15px">Returns a list of all partner settings.</td>
509
+ <td style="padding:15px">{base_path}/{version}/partner_settings?{query}</td>
510
+ <td style="padding:15px">Yes</td>
511
+ </tr>
512
+ <tr>
513
+ <td style="padding:15px">postV3Teammates(body, iapMetadata, callback)</td>
514
+ <td style="padding:15px">Invite teammate</td>
515
+ <td style="padding:15px">{base_path}/{version}/teammates?{query}</td>
516
+ <td style="padding:15px">Yes</td>
517
+ </tr>
518
+ <tr>
519
+ <td style="padding:15px">getV3Teammates(limit, offset, iapMetadata, callback)</td>
520
+ <td style="padding:15px">Retrieve all teammates</td>
521
+ <td style="padding:15px">{base_path}/{version}/teammates?{query}</td>
522
+ <td style="padding:15px">Yes</td>
523
+ </tr>
524
+ <tr>
525
+ <td style="padding:15px">postV3TeammatesPendingTokenResend(token, iapMetadata, callback)</td>
526
+ <td style="padding:15px">Resend teammate invite</td>
527
+ <td style="padding:15px">{base_path}/{version}/teammates/pending/{pathv1}/resend?{query}</td>
528
+ <td style="padding:15px">Yes</td>
529
+ </tr>
530
+ <tr>
531
+ <td style="padding:15px">getV3ScopesRequests(limit, offset, iapMetadata, callback)</td>
532
+ <td style="padding:15px">Retrieve access requests</td>
533
+ <td style="padding:15px">{base_path}/{version}/scopes/requests?{query}</td>
534
+ <td style="padding:15px">Yes</td>
535
+ </tr>
536
+ <tr>
537
+ <td style="padding:15px">getV3TeammatesPending(iapMetadata, callback)</td>
538
+ <td style="padding:15px">Retrieve all pending teammates</td>
539
+ <td style="padding:15px">{base_path}/{version}/teammates/pending?{query}</td>
540
+ <td style="padding:15px">Yes</td>
541
+ </tr>
542
+ <tr>
543
+ <td style="padding:15px">getV3TeammatesUsername(username, iapMetadata, callback)</td>
544
+ <td style="padding:15px">Retrieve specific teammate</td>
545
+ <td style="padding:15px">{base_path}/{version}/teammates/{pathv1}?{query}</td>
546
+ <td style="padding:15px">Yes</td>
547
+ </tr>
548
+ <tr>
549
+ <td style="padding:15px">patchV3TeammatesUsername(username, body, iapMetadata, callback)</td>
550
+ <td style="padding:15px">Update teammate's permissions</td>
551
+ <td style="padding:15px">{base_path}/{version}/teammates/{pathv1}?{query}</td>
552
+ <td style="padding:15px">Yes</td>
553
+ </tr>
554
+ <tr>
555
+ <td style="padding:15px">deleteV3TeammatesUsername(username, iapMetadata, callback)</td>
556
+ <td style="padding:15px">Delete teammate</td>
557
+ <td style="padding:15px">{base_path}/{version}/teammates/{pathv1}?{query}</td>
558
+ <td style="padding:15px">Yes</td>
559
+ </tr>
560
+ <tr>
561
+ <td style="padding:15px">patchV3ScopesRequestsApproveId(requestId, iapMetadata, callback)</td>
562
+ <td style="padding:15px">Approve access request</td>
563
+ <td style="padding:15px">{base_path}/{version}/scopes/requests/{pathv1}/approve?{query}</td>
564
+ <td style="padding:15px">Yes</td>
565
+ </tr>
566
+ <tr>
567
+ <td style="padding:15px">deleteV3ScopesRequestsRequestId(requestId, iapMetadata, callback)</td>
568
+ <td style="padding:15px">Deny access request</td>
569
+ <td style="padding:15px">{base_path}/{version}/scopes/requests/{pathv1}?{query}</td>
570
+ <td style="padding:15px">Yes</td>
571
+ </tr>
572
+ <tr>
573
+ <td style="padding:15px">deleteV3TeammatesPendingToken(token, iapMetadata, callback)</td>
574
+ <td style="padding:15px">Delete pending teammate</td>
575
+ <td style="padding:15px">{base_path}/{version}/teammates/pending/{pathv1}?{query}</td>
576
+ <td style="padding:15px">Yes</td>
577
+ </tr>
578
+ <tr>
579
+ <td style="padding:15px">postAlerts(body, iapMetadata, callback)</td>
580
+ <td style="padding:15px">Create a new Alert</td>
581
+ <td style="padding:15px">{base_path}/{version}/alerts?{query}</td>
582
+ <td style="padding:15px">Yes</td>
583
+ </tr>
584
+ <tr>
585
+ <td style="padding:15px">getAlerts(iapMetadata, callback)</td>
586
+ <td style="padding:15px">Retrieve all alerts</td>
587
+ <td style="padding:15px">{base_path}/{version}/alerts?{query}</td>
588
+ <td style="padding:15px">Yes</td>
589
+ </tr>
590
+ <tr>
591
+ <td style="padding:15px">getAlertsAlertId(alertId, iapMetadata, callback)</td>
592
+ <td style="padding:15px">Retrieve a specific alert</td>
593
+ <td style="padding:15px">{base_path}/{version}/alerts/{pathv1}?{query}</td>
594
+ <td style="padding:15px">Yes</td>
595
+ </tr>
596
+ <tr>
597
+ <td style="padding:15px">deleteAlertsAlertId(alertId, iapMetadata, callback)</td>
598
+ <td style="padding:15px">Delete an alert</td>
599
+ <td style="padding:15px">{base_path}/{version}/alerts/{pathv1}?{query}</td>
600
+ <td style="padding:15px">Yes</td>
601
+ </tr>
602
+ <tr>
603
+ <td style="padding:15px">patchAlertsAlertId(alertId, body, iapMetadata, callback)</td>
604
+ <td style="padding:15px">Update an alert</td>
605
+ <td style="padding:15px">{base_path}/{version}/alerts/{pathv1}?{query}</td>
606
+ <td style="padding:15px">Yes</td>
607
+ </tr>
608
+ <tr>
609
+ <td style="padding:15px">getUserProfile(iapMetadata, callback)</td>
610
+ <td style="padding:15px">Get a user's profile</td>
611
+ <td style="padding:15px">{base_path}/{version}/user/profile?{query}</td>
612
+ <td style="padding:15px">Yes</td>
613
+ </tr>
614
+ <tr>
615
+ <td style="padding:15px">patchUserProfile(body, iapMetadata, callback)</td>
616
+ <td style="padding:15px">Update a user's profile</td>
617
+ <td style="padding:15px">{base_path}/{version}/user/profile?{query}</td>
618
+ <td style="padding:15px">Yes</td>
619
+ </tr>
620
+ <tr>
621
+ <td style="padding:15px">getUserAccount(iapMetadata, callback)</td>
622
+ <td style="padding:15px">Get a user's account information.</td>
623
+ <td style="padding:15px">{base_path}/{version}/user/account?{query}</td>
624
+ <td style="padding:15px">Yes</td>
625
+ </tr>
626
+ <tr>
627
+ <td style="padding:15px">getUserEmail(iapMetadata, callback)</td>
628
+ <td style="padding:15px">Retrieve your account email address</td>
629
+ <td style="padding:15px">{base_path}/{version}/user/email?{query}</td>
630
+ <td style="padding:15px">Yes</td>
631
+ </tr>
632
+ <tr>
633
+ <td style="padding:15px">putUserEmail(body, iapMetadata, callback)</td>
634
+ <td style="padding:15px">Update your account email address</td>
635
+ <td style="padding:15px">{base_path}/{version}/user/email?{query}</td>
636
+ <td style="padding:15px">Yes</td>
637
+ </tr>
638
+ <tr>
639
+ <td style="padding:15px">getUserUsername(iapMetadata, callback)</td>
640
+ <td style="padding:15px">Retrieve your username</td>
641
+ <td style="padding:15px">{base_path}/{version}/user/username?{query}</td>
642
+ <td style="padding:15px">Yes</td>
643
+ </tr>
644
+ <tr>
645
+ <td style="padding:15px">putUserUsername(body, iapMetadata, callback)</td>
646
+ <td style="padding:15px">Update your username</td>
647
+ <td style="padding:15px">{base_path}/{version}/user/username?{query}</td>
648
+ <td style="padding:15px">Yes</td>
649
+ </tr>
650
+ <tr>
651
+ <td style="padding:15px">getUserCredits(iapMetadata, callback)</td>
652
+ <td style="padding:15px">Retrieve your credit balance</td>
653
+ <td style="padding:15px">{base_path}/{version}/user/credits?{query}</td>
654
+ <td style="padding:15px">Yes</td>
655
+ </tr>
656
+ <tr>
657
+ <td style="padding:15px">putUserPassword(body, iapMetadata, callback)</td>
658
+ <td style="padding:15px">Update your password</td>
659
+ <td style="padding:15px">{base_path}/{version}/user/password?{query}</td>
660
+ <td style="padding:15px">Yes</td>
661
+ </tr>
662
+ <tr>
663
+ <td style="padding:15px">getSubusers(username, limit, offset, iapMetadata, callback)</td>
664
+ <td style="padding:15px">List all Subusers</td>
665
+ <td style="padding:15px">{base_path}/{version}/subusers?{query}</td>
666
+ <td style="padding:15px">Yes</td>
667
+ </tr>
668
+ <tr>
669
+ <td style="padding:15px">postSubusers(body, iapMetadata, callback)</td>
670
+ <td style="padding:15px">Create Subuser</td>
671
+ <td style="padding:15px">{base_path}/{version}/subusers?{query}</td>
672
+ <td style="padding:15px">Yes</td>
673
+ </tr>
674
+ <tr>
675
+ <td style="padding:15px">patchSubusersSubuserName(subuserName, body, iapMetadata, callback)</td>
676
+ <td style="padding:15px">Enable/disable a subuser</td>
677
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}?{query}</td>
678
+ <td style="padding:15px">Yes</td>
679
+ </tr>
680
+ <tr>
681
+ <td style="padding:15px">deleteSubusersSubuserName(subuserName, iapMetadata, callback)</td>
682
+ <td style="padding:15px">Delete a subuser</td>
683
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}?{query}</td>
684
+ <td style="padding:15px">Yes</td>
685
+ </tr>
686
+ <tr>
687
+ <td style="padding:15px">getSubusersReputations(usernames, iapMetadata, callback)</td>
688
+ <td style="padding:15px">Retrieve Subuser Reputations</td>
689
+ <td style="padding:15px">{base_path}/{version}/subusers/reputations?{query}</td>
690
+ <td style="padding:15px">Yes</td>
691
+ </tr>
692
+ <tr>
693
+ <td style="padding:15px">putSubusersSubuserNameIps(subuserName, body, iapMetadata, callback)</td>
694
+ <td style="padding:15px">Update IPs assigned to a subuser</td>
695
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/ips?{query}</td>
696
+ <td style="padding:15px">Yes</td>
697
+ </tr>
698
+ <tr>
699
+ <td style="padding:15px">getSubusersSubuserNameMonitor(subuserName, iapMetadata, callback)</td>
700
+ <td style="padding:15px">Retrieve monitor settings for a subuser</td>
701
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/monitor?{query}</td>
702
+ <td style="padding:15px">Yes</td>
703
+ </tr>
704
+ <tr>
705
+ <td style="padding:15px">postSubusersSubuserNameMonitor(subuserName, body, iapMetadata, callback)</td>
706
+ <td style="padding:15px">Create monitor settings</td>
707
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/monitor?{query}</td>
708
+ <td style="padding:15px">Yes</td>
709
+ </tr>
710
+ <tr>
711
+ <td style="padding:15px">putSubusersSubuserNameMonitor(subuserName, body, iapMetadata, callback)</td>
712
+ <td style="padding:15px">Update Monitor Settings for a subuser</td>
713
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/monitor?{query}</td>
714
+ <td style="padding:15px">Yes</td>
715
+ </tr>
716
+ <tr>
717
+ <td style="padding:15px">deleteSubusersSubuserNameMonitor(subuserName, iapMetadata, callback)</td>
718
+ <td style="padding:15px">Delete monitor settings</td>
719
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/monitor?{query}</td>
720
+ <td style="padding:15px">Yes</td>
721
+ </tr>
722
+ <tr>
723
+ <td style="padding:15px">getSubusersSubuserNameStatsMonthly(subuserName, date, sortByMetric, sortByDirection = 'desc', limit, offset, iapMetadata, callback)</td>
724
+ <td style="padding:15px">Retrieve the monthly email statistics for a single subuser</td>
725
+ <td style="padding:15px">{base_path}/{version}/subusers/{pathv1}/stats/monthly?{query}</td>
726
+ <td style="padding:15px">Yes</td>
727
+ </tr>
728
+ <tr>
729
+ <td style="padding:15px">getSubusersStatsMonthly(date, subuser, sortByMetric = 'blocks', sortByDirection = 'desc', limit, offset, iapMetadata, callback)</td>
730
+ <td style="padding:15px">Retrieve monthly stats for all subusers</td>
731
+ <td style="padding:15px">{base_path}/{version}/subusers/stats/monthly?{query}</td>
732
+ <td style="padding:15px">Yes</td>
733
+ </tr>
734
+ <tr>
735
+ <td style="padding:15px">getSubusersStatsSums(sortByDirection = 'desc', startDate, endDate, limit, offset, aggregatedBy, sortByMetric, iapMetadata, callback)</td>
736
+ <td style="padding:15px">Retrieve the totals for each email statistic metric for all subusers.</td>
737
+ <td style="padding:15px">{base_path}/{version}/subusers/stats/sums?{query}</td>
738
+ <td style="padding:15px">Yes</td>
739
+ </tr>
740
+ <tr>
741
+ <td style="padding:15px">getSubusersStats(limit, offset, aggregatedBy = 'day', subusers, startDate, endDate, iapMetadata, callback)</td>
742
+ <td style="padding:15px">Retrieve email statistics for your subusers.</td>
743
+ <td style="padding:15px">{base_path}/{version}/subusers/stats?{query}</td>
744
+ <td style="padding:15px">Yes</td>
745
+ </tr>
746
+ <tr>
747
+ <td style="padding:15px">postWhitelabelLinks(body, iapMetadata, callback)</td>
748
+ <td style="padding:15px">Create a branded link</td>
749
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links?{query}</td>
750
+ <td style="padding:15px">Yes</td>
751
+ </tr>
752
+ <tr>
753
+ <td style="padding:15px">getWhitelabelLinks(limit, iapMetadata, callback)</td>
754
+ <td style="padding:15px">Retrieve all branded links</td>
755
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links?{query}</td>
756
+ <td style="padding:15px">Yes</td>
757
+ </tr>
758
+ <tr>
759
+ <td style="padding:15px">postWhitelabelLinksIdValidate(id, iapMetadata, callback)</td>
760
+ <td style="padding:15px">Validate a branded link</td>
761
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/{pathv1}/validate?{query}</td>
762
+ <td style="padding:15px">Yes</td>
763
+ </tr>
764
+ <tr>
765
+ <td style="padding:15px">postWhitelabelLinksLinkIdSubuser(linkId, body, iapMetadata, callback)</td>
766
+ <td style="padding:15px">Associate a branded link with a subuser</td>
767
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/{pathv1}/subuser?{query}</td>
768
+ <td style="padding:15px">Yes</td>
769
+ </tr>
770
+ <tr>
771
+ <td style="padding:15px">getWhitelabelLinksId(id, iapMetadata, callback)</td>
772
+ <td style="padding:15px">Retrieve a branded link</td>
773
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/{pathv1}?{query}</td>
774
+ <td style="padding:15px">Yes</td>
775
+ </tr>
776
+ <tr>
777
+ <td style="padding:15px">patchWhitelabelLinksId(id, body, iapMetadata, callback)</td>
778
+ <td style="padding:15px">Update a branded link</td>
779
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/{pathv1}?{query}</td>
780
+ <td style="padding:15px">Yes</td>
781
+ </tr>
782
+ <tr>
783
+ <td style="padding:15px">deleteWhitelabelLinksId(id, iapMetadata, callback)</td>
784
+ <td style="padding:15px">Delete a branded link</td>
785
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/{pathv1}?{query}</td>
786
+ <td style="padding:15px">Yes</td>
787
+ </tr>
788
+ <tr>
789
+ <td style="padding:15px">getWhitelabelLinksDefault(domain, iapMetadata, callback)</td>
790
+ <td style="padding:15px">Retrieve the default branded link</td>
791
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/default?{query}</td>
792
+ <td style="padding:15px">Yes</td>
793
+ </tr>
794
+ <tr>
795
+ <td style="padding:15px">getWhitelabelLinksSubuser(username, iapMetadata, callback)</td>
796
+ <td style="padding:15px">Retrieve a subuser's branded link</td>
797
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/subuser?{query}</td>
798
+ <td style="padding:15px">Yes</td>
799
+ </tr>
800
+ <tr>
801
+ <td style="padding:15px">deleteWhitelabelLinksSubuser(username, iapMetadata, callback)</td>
802
+ <td style="padding:15px">Disassociate a branded link from a subuser</td>
803
+ <td style="padding:15px">{base_path}/{version}/whitelabel/links/subuser?{query}</td>
804
+ <td style="padding:15px">Yes</td>
805
+ </tr>
806
+ <tr>
807
+ <td style="padding:15px">postIpsWarmup(body, iapMetadata, callback)</td>
808
+ <td style="padding:15px">Start warming up an IP address</td>
809
+ <td style="padding:15px">{base_path}/{version}/ips/warmup?{query}</td>
810
+ <td style="padding:15px">Yes</td>
811
+ </tr>
812
+ <tr>
813
+ <td style="padding:15px">getIpsWarmup(iapMetadata, callback)</td>
814
+ <td style="padding:15px">Retrieve all IPs currently in warmup</td>
815
+ <td style="padding:15px">{base_path}/{version}/ips/warmup?{query}</td>
816
+ <td style="padding:15px">Yes</td>
817
+ </tr>
818
+ <tr>
819
+ <td style="padding:15px">getIpsWarmupIpAddress(ipAddress, iapMetadata, callback)</td>
820
+ <td style="padding:15px">Retrieve the warmup status for a specific IP address</td>
821
+ <td style="padding:15px">{base_path}/{version}/ips/warmup/{pathv1}?{query}</td>
822
+ <td style="padding:15px">Yes</td>
823
+ </tr>
824
+ <tr>
825
+ <td style="padding:15px">deleteIpsWarmupIpAddress(ipAddress, iapMetadata, callback)</td>
826
+ <td style="padding:15px">Stop warming up an IP address</td>
827
+ <td style="padding:15px">{base_path}/{version}/ips/warmup/{pathv1}?{query}</td>
828
+ <td style="padding:15px">Yes</td>
829
+ </tr>
830
+ <tr>
831
+ <td style="padding:15px">postWhitelabelIps(body, iapMetadata, callback)</td>
832
+ <td style="padding:15px">Set up reverse DNS</td>
833
+ <td style="padding:15px">{base_path}/{version}/whitelabel/ips?{query}</td>
834
+ <td style="padding:15px">Yes</td>
835
+ </tr>
836
+ <tr>
837
+ <td style="padding:15px">getWhitelabelIps(limit, offset, ip, iapMetadata, callback)</td>
838
+ <td style="padding:15px">Retrieve all reverse DNS records</td>
839
+ <td style="padding:15px">{base_path}/{version}/whitelabel/ips?{query}</td>
840
+ <td style="padding:15px">Yes</td>
841
+ </tr>
842
+ <tr>
843
+ <td style="padding:15px">postWhitelabelIpsIdValidate(id, iapMetadata, callback)</td>
844
+ <td style="padding:15px">Validate a reverse DNS record</td>
845
+ <td style="padding:15px">{base_path}/{version}/whitelabel/ips/{pathv1}/validate?{query}</td>
846
+ <td style="padding:15px">Yes</td>
847
+ </tr>
848
+ <tr>
849
+ <td style="padding:15px">getWhitelabelIpsId(id, iapMetadata, callback)</td>
850
+ <td style="padding:15px">Retrieve a reverse DNS record</td>
851
+ <td style="padding:15px">{base_path}/{version}/whitelabel/ips/{pathv1}?{query}</td>
852
+ <td style="padding:15px">Yes</td>
853
+ </tr>
854
+ <tr>
855
+ <td style="padding:15px">deleteWhitelabelIpsId(id, iapMetadata, callback)</td>
856
+ <td style="padding:15px">Delete a reverse DNS record</td>
857
+ <td style="padding:15px">{base_path}/{version}/whitelabel/ips/{pathv1}?{query}</td>
858
+ <td style="padding:15px">Yes</td>
859
+ </tr>
860
+ <tr>
861
+ <td style="padding:15px">postValidationsEmail(body, iapMetadata, callback)</td>
862
+ <td style="padding:15px">Validate an email</td>
863
+ <td style="padding:15px">{base_path}/{version}/validations/email?{query}</td>
864
+ <td style="padding:15px">Yes</td>
865
+ </tr>
866
+ <tr>
867
+ <td style="padding:15px">postWhitelabelDnsEmail(body, iapMetadata, callback)</td>
868
+ <td style="padding:15px">Email DNS records to a co-worker</td>
869
+ <td style="padding:15px">{base_path}/{version}/whitelabel/dns/email?{query}</td>
870
+ <td style="padding:15px">Yes</td>
871
+ </tr>
872
+ <tr>
873
+ <td style="padding:15px">postIpsPools(body, iapMetadata, callback)</td>
874
+ <td style="padding:15px">Create an IP pool</td>
875
+ <td style="padding:15px">{base_path}/{version}/ips/pools?{query}</td>
876
+ <td style="padding:15px">Yes</td>
877
+ </tr>
878
+ <tr>
879
+ <td style="padding:15px">getIpsPools(iapMetadata, callback)</td>
880
+ <td style="padding:15px">Retrieve all IP pools</td>
881
+ <td style="padding:15px">{base_path}/{version}/ips/pools?{query}</td>
882
+ <td style="padding:15px">Yes</td>
883
+ </tr>
884
+ <tr>
885
+ <td style="padding:15px">postIpsPoolsPoolNameIps(poolName, body, iapMetadata, callback)</td>
886
+ <td style="padding:15px">Add an IP address to a pool</td>
887
+ <td style="padding:15px">{base_path}/{version}/ips/pools/{pathv1}/ips?{query}</td>
888
+ <td style="padding:15px">Yes</td>
889
+ </tr>
890
+ <tr>
891
+ <td style="padding:15px">getIpsPoolsPoolName(poolName, iapMetadata, callback)</td>
892
+ <td style="padding:15px">Retrieve all the IPs in a specified pool</td>
893
+ <td style="padding:15px">{base_path}/{version}/ips/pools/{pathv1}?{query}</td>
894
+ <td style="padding:15px">Yes</td>
895
+ </tr>
896
+ <tr>
897
+ <td style="padding:15px">putIpsPoolsPoolName(poolName, body, iapMetadata, callback)</td>
898
+ <td style="padding:15px">Rename an IP pool</td>
899
+ <td style="padding:15px">{base_path}/{version}/ips/pools/{pathv1}?{query}</td>
900
+ <td style="padding:15px">Yes</td>
901
+ </tr>
902
+ <tr>
903
+ <td style="padding:15px">deleteIpsPoolsPoolName(poolName, iapMetadata, callback)</td>
904
+ <td style="padding:15px">Delete an IP pool</td>
905
+ <td style="padding:15px">{base_path}/{version}/ips/pools/{pathv1}?{query}</td>
906
+ <td style="padding:15px">Yes</td>
907
+ </tr>
908
+ <tr>
909
+ <td style="padding:15px">deleteIpsPoolsPoolNameIpsIp(poolName, ip, iapMetadata, callback)</td>
910
+ <td style="padding:15px">Remove an IP address from a pool</td>
911
+ <td style="padding:15px">{base_path}/{version}/ips/pools/{pathv1}/ips/{pathv2}?{query}</td>
912
+ <td style="padding:15px">Yes</td>
913
+ </tr>
914
+ <tr>
915
+ <td style="padding:15px">postIps(body, iapMetadata, callback)</td>
916
+ <td style="padding:15px">Add IPs</td>
917
+ <td style="padding:15px">{base_path}/{version}/ips?{query}</td>
918
+ <td style="padding:15px">Yes</td>
919
+ </tr>
920
+ <tr>
921
+ <td style="padding:15px">getIps(ip, excludeWhitelabels, limit, offset, subuser, sortByDirection = 'desc', iapMetadata, callback)</td>
922
+ <td style="padding:15px">Retrieve all IP addresses</td>
923
+ <td style="padding:15px">{base_path}/{version}/ips?{query}</td>
924
+ <td style="padding:15px">Yes</td>
925
+ </tr>
926
+ <tr>
927
+ <td style="padding:15px">getIpsRemaining(iapMetadata, callback)</td>
928
+ <td style="padding:15px">Get remaining IPs count</td>
929
+ <td style="padding:15px">{base_path}/{version}/ips/remaining?{query}</td>
930
+ <td style="padding:15px">Yes</td>
931
+ </tr>
932
+ <tr>
933
+ <td style="padding:15px">getIpsAssigned(iapMetadata, callback)</td>
934
+ <td style="padding:15px">Retrieve all assigned IPs</td>
935
+ <td style="padding:15px">{base_path}/{version}/ips/assigned?{query}</td>
936
+ <td style="padding:15px">Yes</td>
937
+ </tr>
938
+ <tr>
939
+ <td style="padding:15px">getIpsIpAddress(ipAddress, iapMetadata, callback)</td>
940
+ <td style="padding:15px">Retrieve all IP pools an IP address belongs to</td>
941
+ <td style="padding:15px">{base_path}/{version}/ips/{pathv1}?{query}</td>
942
+ <td style="padding:15px">Yes</td>
943
+ </tr>
944
+ <tr>
945
+ <td style="padding:15px">getWhitelabelDomains(limit, offset, excludeSubusers, username, domain, iapMetadata, callback)</td>
946
+ <td style="padding:15px">List all authenticated domains</td>
947
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains?{query}</td>
948
+ <td style="padding:15px">Yes</td>
949
+ </tr>
950
+ <tr>
951
+ <td style="padding:15px">postWhitelabelDomains(body, iapMetadata, callback)</td>
952
+ <td style="padding:15px">Authenticate a domain</td>
953
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains?{query}</td>
954
+ <td style="padding:15px">Yes</td>
955
+ </tr>
956
+ <tr>
957
+ <td style="padding:15px">getWhitelabelDomainsDomainId(domainId, iapMetadata, callback)</td>
958
+ <td style="padding:15px">Retrieve an authenticated domain</td>
959
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}?{query}</td>
960
+ <td style="padding:15px">Yes</td>
961
+ </tr>
962
+ <tr>
963
+ <td style="padding:15px">patchWhitelabelDomainsDomainId(domainId, body, iapMetadata, callback)</td>
964
+ <td style="padding:15px">Update an authenticated domain</td>
965
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}?{query}</td>
966
+ <td style="padding:15px">Yes</td>
967
+ </tr>
968
+ <tr>
969
+ <td style="padding:15px">deleteWhitelabelDomainsDomainId(domainId, iapMetadata, callback)</td>
970
+ <td style="padding:15px">Delete an authenticated domain.</td>
971
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}?{query}</td>
972
+ <td style="padding:15px">Yes</td>
973
+ </tr>
974
+ <tr>
975
+ <td style="padding:15px">getWhitelabelDomainsDefault(domain, iapMetadata, callback)</td>
976
+ <td style="padding:15px">Get the default authentication</td>
977
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/default?{query}</td>
978
+ <td style="padding:15px">Yes</td>
979
+ </tr>
980
+ <tr>
981
+ <td style="padding:15px">postWhitelabelDomainsIdIps(id, body, iapMetadata, callback)</td>
982
+ <td style="padding:15px">Add an IP to an authenticated domain</td>
983
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}/ips?{query}</td>
984
+ <td style="padding:15px">Yes</td>
985
+ </tr>
986
+ <tr>
987
+ <td style="padding:15px">deleteWhitelabelDomainsIdIpsIp(id, ip, iapMetadata, callback)</td>
988
+ <td style="padding:15px">Remove an IP from an authenticated domain.</td>
989
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}/ips/{pathv2}?{query}</td>
990
+ <td style="padding:15px">Yes</td>
991
+ </tr>
992
+ <tr>
993
+ <td style="padding:15px">postWhitelabelDomainsIdValidate(id, iapMetadata, callback)</td>
994
+ <td style="padding:15px">Validate a domain authentication.</td>
995
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}/validate?{query}</td>
996
+ <td style="padding:15px">Yes</td>
997
+ </tr>
998
+ <tr>
999
+ <td style="padding:15px">getWhitelabelDomainsSubuser(username, iapMetadata, callback)</td>
1000
+ <td style="padding:15px">List the authenticated domain associated with the given user.</td>
1001
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/subuser?{query}</td>
1002
+ <td style="padding:15px">Yes</td>
1003
+ </tr>
1004
+ <tr>
1005
+ <td style="padding:15px">deleteWhitelabelDomainsSubuser(username, iapMetadata, callback)</td>
1006
+ <td style="padding:15px">Disassociate an authenticated domain from a given user.</td>
1007
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/subuser?{query}</td>
1008
+ <td style="padding:15px">Yes</td>
1009
+ </tr>
1010
+ <tr>
1011
+ <td style="padding:15px">postWhitelabelDomainsDomainIdSubuser(domainId, body, iapMetadata, callback)</td>
1012
+ <td style="padding:15px">Associate an authenticated domain with a given user.</td>
1013
+ <td style="padding:15px">{base_path}/{version}/whitelabel/domains/{pathv1}/subuser?{query}</td>
1014
+ <td style="padding:15px">Yes</td>
1015
+ </tr>
1016
+ <tr>
1017
+ <td style="padding:15px">getVerifiedSendersDomains(iapMetadata, callback)</td>
1018
+ <td style="padding:15px">Domain Warn List</td>
1019
+ <td style="padding:15px">{base_path}/{version}/verified_senders/domains?{query}</td>
1020
+ <td style="padding:15px">Yes</td>
1021
+ </tr>
1022
+ <tr>
1023
+ <td style="padding:15px">getVerifiedSendersStepsCompleted(iapMetadata, callback)</td>
1024
+ <td style="padding:15px">Completed Steps</td>
1025
+ <td style="padding:15px">{base_path}/{version}/verified_senders/steps_completed?{query}</td>
1026
+ <td style="padding:15px">Yes</td>
1027
+ </tr>
1028
+ <tr>
1029
+ <td style="padding:15px">postVerifiedSenders(body, iapMetadata, callback)</td>
1030
+ <td style="padding:15px">Create Verified Sender Request</td>
1031
+ <td style="padding:15px">{base_path}/{version}/verified_senders?{query}</td>
1032
+ <td style="padding:15px">Yes</td>
1033
+ </tr>
1034
+ <tr>
1035
+ <td style="padding:15px">getVerifiedSenders(limit, lastSeenID, id, iapMetadata, callback)</td>
1036
+ <td style="padding:15px">Get All Verified Senders</td>
1037
+ <td style="padding:15px">{base_path}/{version}/verified_senders?{query}</td>
1038
+ <td style="padding:15px">Yes</td>
1039
+ </tr>
1040
+ <tr>
1041
+ <td style="padding:15px">getVerifiedSendersVerifyToken(token, iapMetadata, callback)</td>
1042
+ <td style="padding:15px">Verify Sender Request</td>
1043
+ <td style="padding:15px">{base_path}/{version}/verified_senders/verify/{pathv1}?{query}</td>
1044
+ <td style="padding:15px">Yes</td>
1045
+ </tr>
1046
+ <tr>
1047
+ <td style="padding:15px">patchVerifiedSendersId(id, body, iapMetadata, callback)</td>
1048
+ <td style="padding:15px">Edit Verified Sender</td>
1049
+ <td style="padding:15px">{base_path}/{version}/verified_senders/{pathv1}?{query}</td>
1050
+ <td style="padding:15px">Yes</td>
1051
+ </tr>
1052
+ <tr>
1053
+ <td style="padding:15px">deleteVerifiedSendersId(id, iapMetadata, callback)</td>
1054
+ <td style="padding:15px">Delete Verified Sender</td>
1055
+ <td style="padding:15px">{base_path}/{version}/verified_senders/{pathv1}?{query}</td>
1056
+ <td style="padding:15px">Yes</td>
1057
+ </tr>
1058
+ <tr>
1059
+ <td style="padding:15px">postVerifiedSendersResendId(id, iapMetadata, callback)</td>
1060
+ <td style="padding:15px">Resend Verified Sender Request</td>
1061
+ <td style="padding:15px">{base_path}/{version}/verified_senders/resend/{pathv1}?{query}</td>
1062
+ <td style="padding:15px">Yes</td>
1063
+ </tr>
1064
+ <tr>
1065
+ <td style="padding:15px">postDesignDup(id, body, iapMetadata, callback)</td>
1066
+ <td style="padding:15px">Duplicate Design</td>
1067
+ <td style="padding:15px">{base_path}/{version}/designs/{pathv1}?{query}</td>
1068
+ <td style="padding:15px">Yes</td>
1069
+ </tr>
1070
+ <tr>
1071
+ <td style="padding:15px">getDesign(id, iapMetadata, callback)</td>
1072
+ <td style="padding:15px">Get Design</td>
1073
+ <td style="padding:15px">{base_path}/{version}/designs/{pathv1}?{query}</td>
1074
+ <td style="padding:15px">Yes</td>
1075
+ </tr>
1076
+ <tr>
1077
+ <td style="padding:15px">putDesign(id, body, iapMetadata, callback)</td>
1078
+ <td style="padding:15px">Update Design</td>
1079
+ <td style="padding:15px">{base_path}/{version}/designs/{pathv1}?{query}</td>
1080
+ <td style="padding:15px">Yes</td>
1081
+ </tr>
1082
+ <tr>
1083
+ <td style="padding:15px">deleteDesign(id, iapMetadata, callback)</td>
1084
+ <td style="padding:15px">Delete Design</td>
1085
+ <td style="padding:15px">{base_path}/{version}/designs/{pathv1}?{query}</td>
1086
+ <td style="padding:15px">Yes</td>
1087
+ </tr>
1088
+ <tr>
1089
+ <td style="padding:15px">postDesign(body, iapMetadata, callback)</td>
1090
+ <td style="padding:15px">Create Design</td>
1091
+ <td style="padding:15px">{base_path}/{version}/designs?{query}</td>
1092
+ <td style="padding:15px">Yes</td>
1093
+ </tr>
1094
+ <tr>
1095
+ <td style="padding:15px">lISTDesigns(pageSize, pageToken, summary, iapMetadata, callback)</td>
1096
+ <td style="padding:15px">List Designs</td>
1097
+ <td style="padding:15px">{base_path}/{version}/designs?{query}</td>
1098
+ <td style="padding:15px">Yes</td>
1099
+ </tr>
1100
+ <tr>
1101
+ <td style="padding:15px">postSendgridPreBuiltDesign(id, body, iapMetadata, callback)</td>
1102
+ <td style="padding:15px">Duplicate SendGrid Pre-built Design</td>
1103
+ <td style="padding:15px">{base_path}/{version}/designs/pre-builts/{pathv1}?{query}</td>
1104
+ <td style="padding:15px">Yes</td>
1105
+ </tr>
1106
+ <tr>
1107
+ <td style="padding:15px">getSendgridPreBuiltDesign(id, iapMetadata, callback)</td>
1108
+ <td style="padding:15px">Get SendGrid Pre-built Design</td>
1109
+ <td style="padding:15px">{base_path}/{version}/designs/pre-builts/{pathv1}?{query}</td>
1110
+ <td style="padding:15px">Yes</td>
1111
+ </tr>
1112
+ <tr>
1113
+ <td style="padding:15px">lISTSendgridPreBuiltDesigns(pageSize, pageToken, summary, iapMetadata, callback)</td>
1114
+ <td style="padding:15px">List SendGrid Pre-built Designs</td>
1115
+ <td style="padding:15px">{base_path}/{version}/designs/pre-builts?{query}</td>
1116
+ <td style="padding:15px">Yes</td>
1117
+ </tr>
1118
+ <tr>
1119
+ <td style="padding:15px">putMcContacts(body, iapMetadata, callback)</td>
1120
+ <td style="padding:15px">Add or Update a Contact</td>
1121
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts?{query}</td>
1122
+ <td style="padding:15px">Yes</td>
1123
+ </tr>
1124
+ <tr>
1125
+ <td style="padding:15px">deleteMcContacts(deleteAllContacts, ids, iapMetadata, callback)</td>
1126
+ <td style="padding:15px">Delete Contacts</td>
1127
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts?{query}</td>
1128
+ <td style="padding:15px">Yes</td>
1129
+ </tr>
1130
+ <tr>
1131
+ <td style="padding:15px">getMcContats(iapMetadata, callback)</td>
1132
+ <td style="padding:15px">Get Sample Contacts</td>
1133
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts?{query}</td>
1134
+ <td style="padding:15px">Yes</td>
1135
+ </tr>
1136
+ <tr>
1137
+ <td style="padding:15px">getMcContactsCount(iapMetadata, callback)</td>
1138
+ <td style="padding:15px">Get Total Contact Count</td>
1139
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/count?{query}</td>
1140
+ <td style="padding:15px">Yes</td>
1141
+ </tr>
1142
+ <tr>
1143
+ <td style="padding:15px">postMcContactsExports(body, iapMetadata, callback)</td>
1144
+ <td style="padding:15px">Export Contacts</td>
1145
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/exports?{query}</td>
1146
+ <td style="padding:15px">Yes</td>
1147
+ </tr>
1148
+ <tr>
1149
+ <td style="padding:15px">getMarketingContactsExports(iapMetadata, callback)</td>
1150
+ <td style="padding:15px">Get All Existing Exports</td>
1151
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/exports?{query}</td>
1152
+ <td style="padding:15px">Yes</td>
1153
+ </tr>
1154
+ <tr>
1155
+ <td style="padding:15px">getMcContactsId(id, iapMetadata, callback)</td>
1156
+ <td style="padding:15px">Get a Contact by ID</td>
1157
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/{pathv1}?{query}</td>
1158
+ <td style="padding:15px">Yes</td>
1159
+ </tr>
1160
+ <tr>
1161
+ <td style="padding:15px">postMcContactsSearch(body, iapMetadata, callback)</td>
1162
+ <td style="padding:15px">Search Contacts</td>
1163
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/search?{query}</td>
1164
+ <td style="padding:15px">Yes</td>
1165
+ </tr>
1166
+ <tr>
1167
+ <td style="padding:15px">putMcContactsImports(body, iapMetadata, callback)</td>
1168
+ <td style="padding:15px">Import Contacts</td>
1169
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/imports?{query}</td>
1170
+ <td style="padding:15px">Yes</td>
1171
+ </tr>
1172
+ <tr>
1173
+ <td style="padding:15px">getMarketingContactsImportsId(id, iapMetadata, callback)</td>
1174
+ <td style="padding:15px">Import Contacts Status</td>
1175
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/imports/{pathv1}?{query}</td>
1176
+ <td style="padding:15px">Yes</td>
1177
+ </tr>
1178
+ <tr>
1179
+ <td style="padding:15px">getMcContactsExportsId(id, iapMetadata, callback)</td>
1180
+ <td style="padding:15px">Export Contacts Status</td>
1181
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/exports/{pathv1}?{query}</td>
1182
+ <td style="padding:15px">Yes</td>
1183
+ </tr>
1184
+ <tr>
1185
+ <td style="padding:15px">postMarketingContactsBatch(body, iapMetadata, callback)</td>
1186
+ <td style="padding:15px">Get Batched Contacts by IDs</td>
1187
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/batch?{query}</td>
1188
+ <td style="padding:15px">Yes</td>
1189
+ </tr>
1190
+ <tr>
1191
+ <td style="padding:15px">postMarketingContactsSearchEmails(body, iapMetadata, callback)</td>
1192
+ <td style="padding:15px">Get Contacts by Emails</td>
1193
+ <td style="padding:15px">{base_path}/{version}/marketing/contacts/search/emails?{query}</td>
1194
+ <td style="padding:15px">Yes</td>
1195
+ </tr>
1196
+ <tr>
1197
+ <td style="padding:15px">postSegments(body, iapMetadata, callback)</td>
1198
+ <td style="padding:15px">Create Segment</td>
1199
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/2.0?{query}</td>
1200
+ <td style="padding:15px">Yes</td>
1201
+ </tr>
1202
+ <tr>
1203
+ <td style="padding:15px">getSegments(parentListIds, noParentListId, iapMetadata, callback)</td>
1204
+ <td style="padding:15px">Get List of Segments</td>
1205
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/2.0?{query}</td>
1206
+ <td style="padding:15px">Yes</td>
1207
+ </tr>
1208
+ <tr>
1209
+ <td style="padding:15px">patchSegmentsSegmentId(segmentId, body, iapMetadata, callback)</td>
1210
+ <td style="padding:15px">Update Segment</td>
1211
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/2.0/{pathv1}?{query}</td>
1212
+ <td style="padding:15px">Yes</td>
1213
+ </tr>
1214
+ <tr>
1215
+ <td style="padding:15px">getSegmentsSegmentId(segmentId, contactsSample, iapMetadata, callback)</td>
1216
+ <td style="padding:15px">Get Segment by ID</td>
1217
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/2.0/{pathv1}?{query}</td>
1218
+ <td style="padding:15px">Yes</td>
1219
+ </tr>
1220
+ <tr>
1221
+ <td style="padding:15px">deleteSegmentsSegmentId(segmentId, iapMetadata, callback)</td>
1222
+ <td style="padding:15px">Delete segment</td>
1223
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/2.0/{pathv1}?{query}</td>
1224
+ <td style="padding:15px">Yes</td>
1225
+ </tr>
1226
+ <tr>
1227
+ <td style="padding:15px">postMarketingSenders(body, iapMetadata, callback)</td>
1228
+ <td style="padding:15px">Create a Sender Identity</td>
1229
+ <td style="padding:15px">{base_path}/{version}/marketing/senders?{query}</td>
1230
+ <td style="padding:15px">Yes</td>
1231
+ </tr>
1232
+ <tr>
1233
+ <td style="padding:15px">postMcLists(body, iapMetadata, callback)</td>
1234
+ <td style="padding:15px">Create List</td>
1235
+ <td style="padding:15px">{base_path}/{version}/marketing/lists?{query}</td>
1236
+ <td style="padding:15px">Yes</td>
1237
+ </tr>
1238
+ <tr>
1239
+ <td style="padding:15px">getMcLists(pageSize, pageToken, iapMetadata, callback)</td>
1240
+ <td style="padding:15px">Get All Lists</td>
1241
+ <td style="padding:15px">{base_path}/{version}/marketing/lists?{query}</td>
1242
+ <td style="padding:15px">Yes</td>
1243
+ </tr>
1244
+ <tr>
1245
+ <td style="padding:15px">getMcListsIdContactsCount(id, iapMetadata, callback)</td>
1246
+ <td style="padding:15px">Get List Contact Count</td>
1247
+ <td style="padding:15px">{base_path}/{version}/marketing/lists/{pathv1}/contacts/count?{query}</td>
1248
+ <td style="padding:15px">Yes</td>
1249
+ </tr>
1250
+ <tr>
1251
+ <td style="padding:15px">getMcListsId(id, contactSample, iapMetadata, callback)</td>
1252
+ <td style="padding:15px">Get a List by ID</td>
1253
+ <td style="padding:15px">{base_path}/{version}/marketing/lists/{pathv1}?{query}</td>
1254
+ <td style="padding:15px">Yes</td>
1255
+ </tr>
1256
+ <tr>
1257
+ <td style="padding:15px">patchMcListsId(id, body, iapMetadata, callback)</td>
1258
+ <td style="padding:15px">Update List</td>
1259
+ <td style="padding:15px">{base_path}/{version}/marketing/lists/{pathv1}?{query}</td>
1260
+ <td style="padding:15px">Yes</td>
1261
+ </tr>
1262
+ <tr>
1263
+ <td style="padding:15px">deleteListsId(id, deleteContacts, iapMetadata, callback)</td>
1264
+ <td style="padding:15px">Delete a list</td>
1265
+ <td style="padding:15px">{base_path}/{version}/marketing/lists/{pathv1}?{query}</td>
1266
+ <td style="padding:15px">Yes</td>
1267
+ </tr>
1268
+ <tr>
1269
+ <td style="padding:15px">deleteMcListsIdContacts(id, contactIds, iapMetadata, callback)</td>
1270
+ <td style="padding:15px">Remove Contacts from a List</td>
1271
+ <td style="padding:15px">{base_path}/{version}/marketing/lists/{pathv1}/contacts?{query}</td>
1272
+ <td style="padding:15px">Yes</td>
1273
+ </tr>
1274
+ <tr>
1275
+ <td style="padding:15px">postMcFieldDefinitions(body, iapMetadata, callback)</td>
1276
+ <td style="padding:15px">Create Custom Field Definition</td>
1277
+ <td style="padding:15px">{base_path}/{version}/marketing/field_definitions?{query}</td>
1278
+ <td style="padding:15px">Yes</td>
1279
+ </tr>
1280
+ <tr>
1281
+ <td style="padding:15px">getMcFieldDefinitions(iapMetadata, callback)</td>
1282
+ <td style="padding:15px">Get All Field Definitions</td>
1283
+ <td style="padding:15px">{base_path}/{version}/marketing/field_definitions?{query}</td>
1284
+ <td style="padding:15px">Yes</td>
1285
+ </tr>
1286
+ <tr>
1287
+ <td style="padding:15px">patchMcFieldDefinitionsCustomFieldId(customFieldId, body, iapMetadata, callback)</td>
1288
+ <td style="padding:15px">Update Custom Field Definition</td>
1289
+ <td style="padding:15px">{base_path}/{version}/marketing/field_definitions/{pathv1}?{query}</td>
1290
+ <td style="padding:15px">Yes</td>
1291
+ </tr>
1292
+ <tr>
1293
+ <td style="padding:15px">deleteMcFieldDefinitionsCustomFieldId(customFieldId, iapMetadata, callback)</td>
1294
+ <td style="padding:15px">Delete Custom Field Definition</td>
1295
+ <td style="padding:15px">{base_path}/{version}/marketing/field_definitions/{pathv1}?{query}</td>
1296
+ <td style="padding:15px">Yes</td>
1297
+ </tr>
1298
+ <tr>
1299
+ <td style="padding:15px">postMarketingSegments(body, iapMetadata, callback)</td>
1300
+ <td style="padding:15px">Create Segment</td>
1301
+ <td style="padding:15px">{base_path}/{version}/marketing/segments?{query}</td>
1302
+ <td style="padding:15px">Yes</td>
1303
+ </tr>
1304
+ <tr>
1305
+ <td style="padding:15px">getMarketingSegments(parentListIds, noParentListId, iapMetadata, callback)</td>
1306
+ <td style="padding:15px">Get List of Segments</td>
1307
+ <td style="padding:15px">{base_path}/{version}/marketing/segments?{query}</td>
1308
+ <td style="padding:15px">Yes</td>
1309
+ </tr>
1310
+ <tr>
1311
+ <td style="padding:15px">getMarketingSegmentsSegmentId(segmentId, queryJson, iapMetadata, callback)</td>
1312
+ <td style="padding:15px">Get Segment by ID</td>
1313
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/{pathv1}?{query}</td>
1314
+ <td style="padding:15px">Yes</td>
1315
+ </tr>
1316
+ <tr>
1317
+ <td style="padding:15px">patchMarketingSegmentsSegmentId(segmentId, body, iapMetadata, callback)</td>
1318
+ <td style="padding:15px">Update Segment</td>
1319
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/{pathv1}?{query}</td>
1320
+ <td style="padding:15px">Yes</td>
1321
+ </tr>
1322
+ <tr>
1323
+ <td style="padding:15px">deleteMarketingSegmentsSegmentId(segmentId, iapMetadata, callback)</td>
1324
+ <td style="padding:15px">Delete Segment</td>
1325
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/{pathv1}?{query}</td>
1326
+ <td style="padding:15px">Yes</td>
1327
+ </tr>
1328
+ <tr>
1329
+ <td style="padding:15px">postMarketingSegmentsDelete(body, iapMetadata, callback)</td>
1330
+ <td style="padding:15px">Bulk Delete Segments</td>
1331
+ <td style="padding:15px">{base_path}/{version}/marketing/segments/delete?{query}</td>
1332
+ <td style="padding:15px">Yes</td>
1333
+ </tr>
1334
+ <tr>
1335
+ <td style="padding:15px">postMarketingSinglesends(body, iapMetadata, callback)</td>
1336
+ <td style="padding:15px">Create Single Send</td>
1337
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends?{query}</td>
1338
+ <td style="padding:15px">Yes</td>
1339
+ </tr>
1340
+ <tr>
1341
+ <td style="padding:15px">getMarketingSinglesends(pageSize, pageToken, iapMetadata, callback)</td>
1342
+ <td style="padding:15px">Get All Single Sends</td>
1343
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends?{query}</td>
1344
+ <td style="padding:15px">Yes</td>
1345
+ </tr>
1346
+ <tr>
1347
+ <td style="padding:15px">deleteMarketingSinglesends(ids, iapMetadata, callback)</td>
1348
+ <td style="padding:15px">Bulk Delete Single Sends</td>
1349
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends?{query}</td>
1350
+ <td style="padding:15px">Yes</td>
1351
+ </tr>
1352
+ <tr>
1353
+ <td style="padding:15px">postMarketingSinglesendsId(id, body, iapMetadata, callback)</td>
1354
+ <td style="padding:15px">Duplicate Single Send</td>
1355
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}?{query}</td>
1356
+ <td style="padding:15px">Yes</td>
1357
+ </tr>
1358
+ <tr>
1359
+ <td style="padding:15px">patchMarketingSinglesendsId(id, body, iapMetadata, callback)</td>
1360
+ <td style="padding:15px">Update Single Send</td>
1361
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}?{query}</td>
1362
+ <td style="padding:15px">Yes</td>
1363
+ </tr>
1364
+ <tr>
1365
+ <td style="padding:15px">getMarketingSinglesendsId(id, iapMetadata, callback)</td>
1366
+ <td style="padding:15px">Get Single Send by ID</td>
1367
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}?{query}</td>
1368
+ <td style="padding:15px">Yes</td>
1369
+ </tr>
1370
+ <tr>
1371
+ <td style="padding:15px">deleteMarketingSinglesendsId(id, iapMetadata, callback)</td>
1372
+ <td style="padding:15px">Delete Single Send by ID</td>
1373
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}?{query}</td>
1374
+ <td style="padding:15px">Yes</td>
1375
+ </tr>
1376
+ <tr>
1377
+ <td style="padding:15px">postMarketingSinglesendsSearch(pageSize, pageToken, body, iapMetadata, callback)</td>
1378
+ <td style="padding:15px">Get Single Sends Search</td>
1379
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/search?{query}</td>
1380
+ <td style="padding:15px">Yes</td>
1381
+ </tr>
1382
+ <tr>
1383
+ <td style="padding:15px">putMarketingSinglesendsIdSchedule(id, body, iapMetadata, callback)</td>
1384
+ <td style="padding:15px">Schedule Single Send</td>
1385
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}/schedule?{query}</td>
1386
+ <td style="padding:15px">Yes</td>
1387
+ </tr>
1388
+ <tr>
1389
+ <td style="padding:15px">deleteMarketingSinglesendsIdSchedule(id, iapMetadata, callback)</td>
1390
+ <td style="padding:15px">Delete Single Send Schedule</td>
1391
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/{pathv1}/schedule?{query}</td>
1392
+ <td style="padding:15px">Yes</td>
1393
+ </tr>
1394
+ <tr>
1395
+ <td style="padding:15px">getMarketingSinglesendsCategories(iapMetadata, callback)</td>
1396
+ <td style="padding:15px">Get All Categories</td>
1397
+ <td style="padding:15px">{base_path}/{version}/marketing/singlesends/categories?{query}</td>
1398
+ <td style="padding:15px">Yes</td>
1399
+ </tr>
1400
+ <tr>
1401
+ <td style="padding:15px">postMarketingTestSendEmail(body, iapMetadata, callback)</td>
1402
+ <td style="padding:15px">Send a Test Marketing Email</td>
1403
+ <td style="padding:15px">{base_path}/{version}/marketing/test/send_email?{query}</td>
1404
+ <td style="padding:15px">Yes</td>
1405
+ </tr>
1406
+ <tr>
1407
+ <td style="padding:15px">getallAutomationStats(automationIds, pageSize, pageToken, iapMetadata, callback)</td>
1408
+ <td style="padding:15px">Get All Automation Stats</td>
1409
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/automations?{query}</td>
1410
+ <td style="padding:15px">Yes</td>
1411
+ </tr>
1412
+ <tr>
1413
+ <td style="padding:15px">getAutomationStat(id, groupBy, stepIds, aggregatedBy = 'day', startDate, endDate, timezone, pageSize, pageToken, iapMetadata, callback)</td>
1414
+ <td style="padding:15px">Get Automation Stats by ID</td>
1415
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/automations/{pathv1}?{query}</td>
1416
+ <td style="padding:15px">Yes</td>
1417
+ </tr>
1418
+ <tr>
1419
+ <td style="padding:15px">getallSinglesendStats(singlesendIds, pageSize, pageToken, iapMetadata, callback)</td>
1420
+ <td style="padding:15px">Get All Single Sends Stats</td>
1421
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/singlesends?{query}</td>
1422
+ <td style="padding:15px">Yes</td>
1423
+ </tr>
1424
+ <tr>
1425
+ <td style="padding:15px">getSinglesendStat(id, aggregatedBy = 'day', startDate, endDate, timezone, pageSize, pageToken, groupBy, iapMetadata, callback)</td>
1426
+ <td style="padding:15px">Get Single Send Stats by ID</td>
1427
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/singlesends/{pathv1}?{query}</td>
1428
+ <td style="padding:15px">Yes</td>
1429
+ </tr>
1430
+ <tr>
1431
+ <td style="padding:15px">getAutomationLinkStat(id, groupBy, stepIds, pageSize, pageToken, iapMetadata, callback)</td>
1432
+ <td style="padding:15px">Get Automation Click Tracking Stats by ID</td>
1433
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/automations/{pathv1}/links?{query}</td>
1434
+ <td style="padding:15px">Yes</td>
1435
+ </tr>
1436
+ <tr>
1437
+ <td style="padding:15px">getSinglesendLinkStat(id, pageSize, pageToken, groupBy, abVariationId, abPhaseId = 'test', iapMetadata, callback)</td>
1438
+ <td style="padding:15px">Get Single Send Click Tracking Stats by ID</td>
1439
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/singlesends/{pathv1}/links?{query}</td>
1440
+ <td style="padding:15px">Yes</td>
1441
+ </tr>
1442
+ <tr>
1443
+ <td style="padding:15px">getSinglesendStatsExport(ids, timezone, iapMetadata, callback)</td>
1444
+ <td style="padding:15px">Export Single Send Stats</td>
1445
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/singlesends/export?{query}</td>
1446
+ <td style="padding:15px">Yes</td>
1447
+ </tr>
1448
+ <tr>
1449
+ <td style="padding:15px">getAutomationsStatsExport(ids, timezone, iapMetadata, callback)</td>
1450
+ <td style="padding:15px">Export Automation Stats</td>
1451
+ <td style="padding:15px">{base_path}/{version}/marketing/stats/automations/export?{query}</td>
1452
+ <td style="padding:15px">Yes</td>
1453
+ </tr>
1454
+ <tr>
1455
+ <td style="padding:15px">postSenders(body, iapMetadata, callback)</td>
1456
+ <td style="padding:15px">Create a Sender Identity</td>
1457
+ <td style="padding:15px">{base_path}/{version}/senders?{query}</td>
1458
+ <td style="padding:15px">Yes</td>
1459
+ </tr>
1460
+ <tr>
1461
+ <td style="padding:15px">getV3Senders(iapMetadata, callback)</td>
1462
+ <td style="padding:15px">Get all Sender Identities</td>
1463
+ <td style="padding:15px">{base_path}/{version}/senders?{query}</td>
1464
+ <td style="padding:15px">Yes</td>
1465
+ </tr>
1466
+ <tr>
1467
+ <td style="padding:15px">getV3SendersSenderId(senderId, iapMetadata, callback)</td>
1468
+ <td style="padding:15px">View a Sender Identity</td>
1469
+ <td style="padding:15px">{base_path}/{version}/senders/{pathv1}?{query}</td>
1470
+ <td style="padding:15px">Yes</td>
1471
+ </tr>
1472
+ <tr>
1473
+ <td style="padding:15px">patchV3SendersSenderId(senderId, body, iapMetadata, callback)</td>
1474
+ <td style="padding:15px">Update a Sender Identity</td>
1475
+ <td style="padding:15px">{base_path}/{version}/senders/{pathv1}?{query}</td>
1476
+ <td style="padding:15px">Yes</td>
1477
+ </tr>
1478
+ <tr>
1479
+ <td style="padding:15px">deleteV3SendersSenderId(senderId, iapMetadata, callback)</td>
1480
+ <td style="padding:15px">Delete a Sender Identity</td>
1481
+ <td style="padding:15px">{base_path}/{version}/senders/{pathv1}?{query}</td>
1482
+ <td style="padding:15px">Yes</td>
1483
+ </tr>
1484
+ <tr>
1485
+ <td style="padding:15px">postV3SendersSenderIdResendVerification(senderId, iapMetadata, callback)</td>
1486
+ <td style="padding:15px">Resend Sender Identity Verification</td>
1487
+ <td style="padding:15px">{base_path}/{version}/senders/{pathv1}/resend_verification?{query}</td>
1488
+ <td style="padding:15px">Yes</td>
1489
+ </tr>
1490
+ <tr>
1491
+ <td style="padding:15px">postContactdbLists(body, iapMetadata, callback)</td>
1492
+ <td style="padding:15px">Create a List</td>
1493
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists?{query}</td>
1494
+ <td style="padding:15px">Yes</td>
1495
+ </tr>
1496
+ <tr>
1497
+ <td style="padding:15px">getContactdbLists(iapMetadata, callback)</td>
1498
+ <td style="padding:15px">Retrieve all lists</td>
1499
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists?{query}</td>
1500
+ <td style="padding:15px">Yes</td>
1501
+ </tr>
1502
+ <tr>
1503
+ <td style="padding:15px">deleteContactdbLists(body, iapMetadata, callback)</td>
1504
+ <td style="padding:15px">Delete Multiple lists</td>
1505
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists?{query}</td>
1506
+ <td style="padding:15px">Yes</td>
1507
+ </tr>
1508
+ <tr>
1509
+ <td style="padding:15px">getContactdbListsListId(listId, iapMetadata, callback)</td>
1510
+ <td style="padding:15px">Retrieve a single list</td>
1511
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}?{query}</td>
1512
+ <td style="padding:15px">Yes</td>
1513
+ </tr>
1514
+ <tr>
1515
+ <td style="padding:15px">patchContactdbListsListId(listId, body, iapMetadata, callback)</td>
1516
+ <td style="padding:15px">Update a List</td>
1517
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}?{query}</td>
1518
+ <td style="padding:15px">Yes</td>
1519
+ </tr>
1520
+ <tr>
1521
+ <td style="padding:15px">deleteContactdbListsListId(listId, deleteContacts, body, iapMetadata, callback)</td>
1522
+ <td style="padding:15px">Delete a List</td>
1523
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}?{query}</td>
1524
+ <td style="padding:15px">Yes</td>
1525
+ </tr>
1526
+ <tr>
1527
+ <td style="padding:15px">getContactdbListsListIdRecipients(page, pageSize, listId, iapMetadata, callback)</td>
1528
+ <td style="padding:15px">Retrieve all recipients on a List</td>
1529
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}/recipients?{query}</td>
1530
+ <td style="padding:15px">Yes</td>
1531
+ </tr>
1532
+ <tr>
1533
+ <td style="padding:15px">postContactdbListsListIdRecipients(listId, body, iapMetadata, callback)</td>
1534
+ <td style="padding:15px">Add Multiple Recipients to a List</td>
1535
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}/recipients?{query}</td>
1536
+ <td style="padding:15px">Yes</td>
1537
+ </tr>
1538
+ <tr>
1539
+ <td style="padding:15px">postContactdbListsListIdRecipientsRecipientId(listId, recipientId, iapMetadata, callback)</td>
1540
+ <td style="padding:15px">Add a Single Recipient to a List</td>
1541
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}/recipients/{pathv2}?{query}</td>
1542
+ <td style="padding:15px">Yes</td>
1543
+ </tr>
1544
+ <tr>
1545
+ <td style="padding:15px">deleteContactdbListsListIdRecipientsRecipientId(listId, recipientId, body, iapMetadata, callback)</td>
1546
+ <td style="padding:15px">Delete a Single Recipient from a Single List</td>
1547
+ <td style="padding:15px">{base_path}/{version}/contactdb/lists/{pathv1}/recipients/{pathv2}?{query}</td>
1548
+ <td style="padding:15px">Yes</td>
1549
+ </tr>
1550
+ <tr>
1551
+ <td style="padding:15px">postContactdbRecipients(body, iapMetadata, callback)</td>
1552
+ <td style="padding:15px">Add recipients</td>
1553
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients?{query}</td>
1554
+ <td style="padding:15px">Yes</td>
1555
+ </tr>
1556
+ <tr>
1557
+ <td style="padding:15px">patchContactdbRecipients(body, iapMetadata, callback)</td>
1558
+ <td style="padding:15px">Update Recipient</td>
1559
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients?{query}</td>
1560
+ <td style="padding:15px">Yes</td>
1561
+ </tr>
1562
+ <tr>
1563
+ <td style="padding:15px">deleteContactdbRecipients(body, iapMetadata, callback)</td>
1564
+ <td style="padding:15px">Delete Recipients</td>
1565
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients?{query}</td>
1566
+ <td style="padding:15px">Yes</td>
1567
+ </tr>
1568
+ <tr>
1569
+ <td style="padding:15px">getContactdbRecipients(page, pageSize, iapMetadata, callback)</td>
1570
+ <td style="padding:15px">Retrieve recipients</td>
1571
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients?{query}</td>
1572
+ <td style="padding:15px">Yes</td>
1573
+ </tr>
1574
+ <tr>
1575
+ <td style="padding:15px">getContactdbStatus(iapMetadata, callback)</td>
1576
+ <td style="padding:15px">Get Recipient Upload Status</td>
1577
+ <td style="padding:15px">{base_path}/{version}/contactdb/status?{query}</td>
1578
+ <td style="padding:15px">Yes</td>
1579
+ </tr>
1580
+ <tr>
1581
+ <td style="padding:15px">getContactdbRecipientsRecipientId(recipientId, iapMetadata, callback)</td>
1582
+ <td style="padding:15px">Retrieve a single recipient</td>
1583
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/{pathv1}?{query}</td>
1584
+ <td style="padding:15px">Yes</td>
1585
+ </tr>
1586
+ <tr>
1587
+ <td style="padding:15px">deleteContactdbRecipientsRecipientId(recipientId, iapMetadata, callback)</td>
1588
+ <td style="padding:15px">Delete a Recipient</td>
1589
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/{pathv1}?{query}</td>
1590
+ <td style="padding:15px">Yes</td>
1591
+ </tr>
1592
+ <tr>
1593
+ <td style="padding:15px">getContactdbRecipientsRecipientIdLists(recipientId, iapMetadata, callback)</td>
1594
+ <td style="padding:15px">Retrieve the lists that a recipient is on</td>
1595
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/{pathv1}/lists?{query}</td>
1596
+ <td style="padding:15px">Yes</td>
1597
+ </tr>
1598
+ <tr>
1599
+ <td style="padding:15px">getContactdbRecipientsBillableCount(iapMetadata, callback)</td>
1600
+ <td style="padding:15px">Retrieve the count of billable recipients</td>
1601
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/billable_count?{query}</td>
1602
+ <td style="padding:15px">Yes</td>
1603
+ </tr>
1604
+ <tr>
1605
+ <td style="padding:15px">getContactdbRecipientsCount(iapMetadata, callback)</td>
1606
+ <td style="padding:15px">Retrieve a Count of Recipients</td>
1607
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/count?{query}</td>
1608
+ <td style="padding:15px">Yes</td>
1609
+ </tr>
1610
+ <tr>
1611
+ <td style="padding:15px">getContactdbRecipientsSearch(fieldName, iapMetadata, callback)</td>
1612
+ <td style="padding:15px">Search recipients</td>
1613
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/search?{query}</td>
1614
+ <td style="padding:15px">Yes</td>
1615
+ </tr>
1616
+ <tr>
1617
+ <td style="padding:15px">postContactdbRecipientsSearch(body, iapMetadata, callback)</td>
1618
+ <td style="padding:15px">Search recipients</td>
1619
+ <td style="padding:15px">{base_path}/{version}/contactdb/recipients/search?{query}</td>
1620
+ <td style="padding:15px">Yes</td>
1621
+ </tr>
1622
+ <tr>
1623
+ <td style="padding:15px">postContactdbCustomFields(body, iapMetadata, callback)</td>
1624
+ <td style="padding:15px">Create a Custom Field</td>
1625
+ <td style="padding:15px">{base_path}/{version}/contactdb/custom_fields?{query}</td>
1626
+ <td style="padding:15px">Yes</td>
1627
+ </tr>
1628
+ <tr>
1629
+ <td style="padding:15px">getContactdbCustomFields(iapMetadata, callback)</td>
1630
+ <td style="padding:15px">Retrieve all custom fields</td>
1631
+ <td style="padding:15px">{base_path}/{version}/contactdb/custom_fields?{query}</td>
1632
+ <td style="padding:15px">Yes</td>
1633
+ </tr>
1634
+ <tr>
1635
+ <td style="padding:15px">getContactdbCustomFieldsCustomFieldId(customFieldId, iapMetadata, callback)</td>
1636
+ <td style="padding:15px">Retrieve a Custom Field</td>
1637
+ <td style="padding:15px">{base_path}/{version}/contactdb/custom_fields/{pathv1}?{query}</td>
1638
+ <td style="padding:15px">Yes</td>
1639
+ </tr>
1640
+ <tr>
1641
+ <td style="padding:15px">deleteContactdbCustomFieldsCustomFieldId(customFieldId, iapMetadata, callback)</td>
1642
+ <td style="padding:15px">Delete a Custom Field</td>
1643
+ <td style="padding:15px">{base_path}/{version}/contactdb/custom_fields/{pathv1}?{query}</td>
1644
+ <td style="padding:15px">Yes</td>
1645
+ </tr>
1646
+ <tr>
1647
+ <td style="padding:15px">getContactdbReservedFields(iapMetadata, callback)</td>
1648
+ <td style="padding:15px">Retrieve reserved fields</td>
1649
+ <td style="padding:15px">{base_path}/{version}/contactdb/reserved_fields?{query}</td>
1650
+ <td style="padding:15px">Yes</td>
1651
+ </tr>
1652
+ <tr>
1653
+ <td style="padding:15px">postContactdbSegments(body, iapMetadata, callback)</td>
1654
+ <td style="padding:15px">Create a Segment</td>
1655
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments?{query}</td>
1656
+ <td style="padding:15px">Yes</td>
1657
+ </tr>
1658
+ <tr>
1659
+ <td style="padding:15px">getContactdbSegments(iapMetadata, callback)</td>
1660
+ <td style="padding:15px">Retrieve all segments</td>
1661
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments?{query}</td>
1662
+ <td style="padding:15px">Yes</td>
1663
+ </tr>
1664
+ <tr>
1665
+ <td style="padding:15px">getContactdbSegmentsSegmentId(segmentId, iapMetadata, callback)</td>
1666
+ <td style="padding:15px">Retrieve a segment</td>
1667
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments/{pathv1}?{query}</td>
1668
+ <td style="padding:15px">Yes</td>
1669
+ </tr>
1670
+ <tr>
1671
+ <td style="padding:15px">patchContactdbSegmentsSegmentId(segmentId, body, iapMetadata, callback)</td>
1672
+ <td style="padding:15px">Update a segment</td>
1673
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments/{pathv1}?{query}</td>
1674
+ <td style="padding:15px">Yes</td>
1675
+ </tr>
1676
+ <tr>
1677
+ <td style="padding:15px">deleteContactdbSegmentsSegmentId(segmentId, deleteContacts, body, iapMetadata, callback)</td>
1678
+ <td style="padding:15px">Delete a segment</td>
1679
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments/{pathv1}?{query}</td>
1680
+ <td style="padding:15px">Yes</td>
1681
+ </tr>
1682
+ <tr>
1683
+ <td style="padding:15px">getContactdbSegmentsSegmentIdRecipients(segmentId, page, pageSize, iapMetadata, callback)</td>
1684
+ <td style="padding:15px">Retrieve recipients on a segment</td>
1685
+ <td style="padding:15px">{base_path}/{version}/contactdb/segments/{pathv1}/recipients?{query}</td>
1686
+ <td style="padding:15px">Yes</td>
1687
+ </tr>
1688
+ <tr>
1689
+ <td style="padding:15px">getCategories(limit, category, offset, iapMetadata, callback)</td>
1690
+ <td style="padding:15px">Retrieve all categories</td>
1691
+ <td style="padding:15px">{base_path}/{version}/categories?{query}</td>
1692
+ <td style="padding:15px">Yes</td>
1693
+ </tr>
1694
+ <tr>
1695
+ <td style="padding:15px">getCategoriesStatsSums(sortByMetric, sortByDirection = 'desc', startDate, endDate, limit, offset, aggregatedBy = 'day', iapMetadata, callback)</td>
1696
+ <td style="padding:15px">Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]</td>
1697
+ <td style="padding:15px">{base_path}/{version}/categories/stats/sums?{query}</td>
1698
+ <td style="padding:15px">Yes</td>
1699
+ </tr>
1700
+ <tr>
1701
+ <td style="padding:15px">getCategoriesStats(startDate, endDate, categories, limit, offset, aggregatedBy = 'day', iapMetadata, callback)</td>
1702
+ <td style="padding:15px">Retrieve Email Statistics for Categories</td>
1703
+ <td style="padding:15px">{base_path}/{version}/categories/stats?{query}</td>
1704
+ <td style="padding:15px">Yes</td>
1705
+ </tr>
1706
+ <tr>
1707
+ <td style="padding:15px">postCampaigns(body, iapMetadata, callback)</td>
1708
+ <td style="padding:15px">Create a Campaign</td>
1709
+ <td style="padding:15px">{base_path}/{version}/campaigns?{query}</td>
1710
+ <td style="padding:15px">Yes</td>
1711
+ </tr>
1712
+ <tr>
1713
+ <td style="padding:15px">getCampaigns(limit, offset, iapMetadata, callback)</td>
1714
+ <td style="padding:15px">Retrieve all Campaigns</td>
1715
+ <td style="padding:15px">{base_path}/{version}/campaigns?{query}</td>
1716
+ <td style="padding:15px">Yes</td>
1717
+ </tr>
1718
+ <tr>
1719
+ <td style="padding:15px">getCampaignsCampaignId(campaignId, iapMetadata, callback)</td>
1720
+ <td style="padding:15px">Retrieve a single campaign</td>
1721
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}?{query}</td>
1722
+ <td style="padding:15px">Yes</td>
1723
+ </tr>
1724
+ <tr>
1725
+ <td style="padding:15px">deleteCampaignsCampaignId(campaignId, iapMetadata, callback)</td>
1726
+ <td style="padding:15px">Delete a Campaign</td>
1727
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}?{query}</td>
1728
+ <td style="padding:15px">Yes</td>
1729
+ </tr>
1730
+ <tr>
1731
+ <td style="padding:15px">patchCampaignsCampaignId(campaignId, body, iapMetadata, callback)</td>
1732
+ <td style="padding:15px">Update a Campaign</td>
1733
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}?{query}</td>
1734
+ <td style="padding:15px">Yes</td>
1735
+ </tr>
1736
+ <tr>
1737
+ <td style="padding:15px">postCampaignsCampaignIdSchedulesNow(campaignId, iapMetadata, callback)</td>
1738
+ <td style="padding:15px">Send a Campaign</td>
1739
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules/now?{query}</td>
1740
+ <td style="padding:15px">Yes</td>
1741
+ </tr>
1742
+ <tr>
1743
+ <td style="padding:15px">postCampaignsCampaignIdSchedules(campaignId, body, iapMetadata, callback)</td>
1744
+ <td style="padding:15px">Schedule a Campaign</td>
1745
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules?{query}</td>
1746
+ <td style="padding:15px">Yes</td>
1747
+ </tr>
1748
+ <tr>
1749
+ <td style="padding:15px">patchCampaignsCampaignIdSchedules(campaignId, body, iapMetadata, callback)</td>
1750
+ <td style="padding:15px">Update a Scheduled Campaign</td>
1751
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules?{query}</td>
1752
+ <td style="padding:15px">Yes</td>
1753
+ </tr>
1754
+ <tr>
1755
+ <td style="padding:15px">getCampaignsCampaignIdSchedules(campaignId, iapMetadata, callback)</td>
1756
+ <td style="padding:15px">View Scheduled Time of a Campaign</td>
1757
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules?{query}</td>
1758
+ <td style="padding:15px">Yes</td>
1759
+ </tr>
1760
+ <tr>
1761
+ <td style="padding:15px">deleteCampaignsCampaignIdSchedules(campaignId, iapMetadata, callback)</td>
1762
+ <td style="padding:15px">Unschedule a Scheduled Campaign</td>
1763
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules?{query}</td>
1764
+ <td style="padding:15px">Yes</td>
1765
+ </tr>
1766
+ <tr>
1767
+ <td style="padding:15px">postCampaignsCampaignIdSchedulesTest(campaignId, body, iapMetadata, callback)</td>
1768
+ <td style="padding:15px">Send a Test Campaign</td>
1769
+ <td style="padding:15px">{base_path}/{version}/campaigns/{pathv1}/schedules/test?{query}</td>
1770
+ <td style="padding:15px">Yes</td>
1771
+ </tr>
1772
+ <tr>
1773
+ <td style="padding:15px">postTemplates(body, iapMetadata, callback)</td>
1774
+ <td style="padding:15px">Create a transactional template.</td>
1775
+ <td style="padding:15px">{base_path}/{version}/templates?{query}</td>
1776
+ <td style="padding:15px">Yes</td>
1777
+ </tr>
1778
+ <tr>
1779
+ <td style="padding:15px">getTemplates(generations = 'legacy', pageSize, pageToken, iapMetadata, callback)</td>
1780
+ <td style="padding:15px">Retrieve paged transactional templates.</td>
1781
+ <td style="padding:15px">{base_path}/{version}/templates?{query}</td>
1782
+ <td style="padding:15px">Yes</td>
1783
+ </tr>
1784
+ <tr>
1785
+ <td style="padding:15px">postTemplatesTemplateId(templateId, body, iapMetadata, callback)</td>
1786
+ <td style="padding:15px">Duplicate a transactional template.</td>
1787
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}?{query}</td>
1788
+ <td style="padding:15px">Yes</td>
1789
+ </tr>
1790
+ <tr>
1791
+ <td style="padding:15px">getTemplatesTemplateId(templateId, iapMetadata, callback)</td>
1792
+ <td style="padding:15px">Retrieve a single transactional template.</td>
1793
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}?{query}</td>
1794
+ <td style="padding:15px">Yes</td>
1795
+ </tr>
1796
+ <tr>
1797
+ <td style="padding:15px">patchTemplatesTemplateId(templateId, body, iapMetadata, callback)</td>
1798
+ <td style="padding:15px">Edit a transactional template.</td>
1799
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}?{query}</td>
1800
+ <td style="padding:15px">Yes</td>
1801
+ </tr>
1802
+ <tr>
1803
+ <td style="padding:15px">deleteTemplatesTemplateId(templateId, iapMetadata, callback)</td>
1804
+ <td style="padding:15px">Delete a template.</td>
1805
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}?{query}</td>
1806
+ <td style="padding:15px">Yes</td>
1807
+ </tr>
1808
+ <tr>
1809
+ <td style="padding:15px">postTemplatesTemplateIdVersions(templateId, body, iapMetadata, callback)</td>
1810
+ <td style="padding:15px">Create a new transactional template version.</td>
1811
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}/versions?{query}</td>
1812
+ <td style="padding:15px">Yes</td>
1813
+ </tr>
1814
+ <tr>
1815
+ <td style="padding:15px">postTemplatesTemplateIdVersionsVersionIdActivate(templateId, versionId, iapMetadata, callback)</td>
1816
+ <td style="padding:15px">Activate a transactional template version.</td>
1817
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}/versions/{pathv2}/activate?{query}</td>
1818
+ <td style="padding:15px">Yes</td>
1819
+ </tr>
1820
+ <tr>
1821
+ <td style="padding:15px">getTemplatesTemplateIdVersionsVersionId(templateId, versionId, iapMetadata, callback)</td>
1822
+ <td style="padding:15px">Retrieve a specific transactional template version.</td>
1823
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}/versions/{pathv2}?{query}</td>
1824
+ <td style="padding:15px">Yes</td>
1825
+ </tr>
1826
+ <tr>
1827
+ <td style="padding:15px">patchTemplatesTemplateIdVersionsVersionId(templateId, versionId, body, iapMetadata, callback)</td>
1828
+ <td style="padding:15px">Edit a transactional template version.</td>
1829
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}/versions/{pathv2}?{query}</td>
1830
+ <td style="padding:15px">Yes</td>
1831
+ </tr>
1832
+ <tr>
1833
+ <td style="padding:15px">deleteTemplatesTemplateIdVersionsVersionId(templateId, versionId, iapMetadata, callback)</td>
1834
+ <td style="padding:15px">Delete a transactional template version.</td>
1835
+ <td style="padding:15px">{base_path}/{version}/templates/{pathv1}/versions/{pathv2}?{query}</td>
1836
+ <td style="padding:15px">Yes</td>
1837
+ </tr>
1838
+ <tr>
1839
+ <td style="padding:15px">getUserWebhooksEventSettings(iapMetadata, callback)</td>
1840
+ <td style="padding:15px">Retrieve Event Webhook settings</td>
1841
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/event/settings?{query}</td>
1842
+ <td style="padding:15px">Yes</td>
1843
+ </tr>
1844
+ <tr>
1845
+ <td style="padding:15px">patchUserWebhooksEventSettings(body, iapMetadata, callback)</td>
1846
+ <td style="padding:15px">Update Event Notification Settings</td>
1847
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/event/settings?{query}</td>
1848
+ <td style="padding:15px">Yes</td>
1849
+ </tr>
1850
+ <tr>
1851
+ <td style="padding:15px">getUserWebhooksParseSettings(iapMetadata, callback)</td>
1852
+ <td style="padding:15px">Retrieve all parse settings</td>
1853
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/settings?{query}</td>
1854
+ <td style="padding:15px">Yes</td>
1855
+ </tr>
1856
+ <tr>
1857
+ <td style="padding:15px">getUserWebhooksParseStats(limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
1858
+ <td style="padding:15px">Retrieves Inbound Parse Webhook statistics.</td>
1859
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/stats?{query}</td>
1860
+ <td style="padding:15px">Yes</td>
1861
+ </tr>
1862
+ <tr>
1863
+ <td style="padding:15px">getUserWebhooksEventSettingsSigned(iapMetadata, callback)</td>
1864
+ <td style="padding:15px">Retrieve Signed Webhook Public Key</td>
1865
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/event/settings/signed?{query}</td>
1866
+ <td style="padding:15px">Yes</td>
1867
+ </tr>
1868
+ <tr>
1869
+ <td style="padding:15px">patchUserWebhooksEventSettingsSigned(body, iapMetadata, callback)</td>
1870
+ <td style="padding:15px">Enable/Disable Signed Webhook</td>
1871
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/event/settings/signed?{query}</td>
1872
+ <td style="padding:15px">Yes</td>
1873
+ </tr>
1874
+ <tr>
1875
+ <td style="padding:15px">postUserWebhooksEventTest(body, iapMetadata, callback)</td>
1876
+ <td style="padding:15px">Test Event Notification Settings</td>
1877
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/event/test?{query}</td>
1878
+ <td style="padding:15px">Yes</td>
1879
+ </tr>
1880
+ <tr>
1881
+ <td style="padding:15px">postUserWebhooksParseSettings(body, iapMetadata, callback)</td>
1882
+ <td style="padding:15px">Create a parse setting</td>
1883
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/settings?{query}</td>
1884
+ <td style="padding:15px">Yes</td>
1885
+ </tr>
1886
+ <tr>
1887
+ <td style="padding:15px">getUserWebhooksParseSettingsHostname(hostname, iapMetadata, callback)</td>
1888
+ <td style="padding:15px">Retrieve a specific parse setting</td>
1889
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/settings/{pathv1}?{query}</td>
1890
+ <td style="padding:15px">Yes</td>
1891
+ </tr>
1892
+ <tr>
1893
+ <td style="padding:15px">patchUserWebhooksParseSettingsHostname(hostname, body, iapMetadata, callback)</td>
1894
+ <td style="padding:15px">Update a parse setting</td>
1895
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/settings/{pathv1}?{query}</td>
1896
+ <td style="padding:15px">Yes</td>
1897
+ </tr>
1898
+ <tr>
1899
+ <td style="padding:15px">deleteUserWebhooksParseSettingsHostname(hostname, iapMetadata, callback)</td>
1900
+ <td style="padding:15px">Delete a parse setting</td>
1901
+ <td style="padding:15px">{base_path}/{version}/user/webhooks/parse/settings/{pathv1}?{query}</td>
1902
+ <td style="padding:15px">Yes</td>
1903
+ </tr>
1904
+ <tr>
1905
+ <td style="padding:15px">getMessages(query, limit, iapMetadata, callback)</td>
1906
+ <td style="padding:15px">Filter all messages</td>
1907
+ <td style="padding:15px">{base_path}/{version}/messages?{query}</td>
1908
+ <td style="padding:15px">Yes</td>
1909
+ </tr>
1910
+ <tr>
1911
+ <td style="padding:15px">getV3MessagesMsgId(msgId, iapMetadata, callback)</td>
1912
+ <td style="padding:15px">Filter messages by message ID</td>
1913
+ <td style="padding:15px">{base_path}/{version}/messages/{pathv1}?{query}</td>
1914
+ <td style="padding:15px">Yes</td>
1915
+ </tr>
1916
+ <tr>
1917
+ <td style="padding:15px">postV3MessagesDownload(query, iapMetadata, callback)</td>
1918
+ <td style="padding:15px">Request CSV</td>
1919
+ <td style="padding:15px">{base_path}/{version}/messages/download?{query}</td>
1920
+ <td style="padding:15px">Yes</td>
1921
+ </tr>
1922
+ <tr>
1923
+ <td style="padding:15px">getV3MessagesDownloadDownloadUuid(downloadUuid, iapMetadata, callback)</td>
1924
+ <td style="padding:15px">Download CSV</td>
1925
+ <td style="padding:15px">{base_path}/{version}/messages/download/{pathv1}?{query}</td>
1926
+ <td style="padding:15px">Yes</td>
1927
+ </tr>
1928
+ <tr>
1929
+ <td style="padding:15px">getTrackingSettings(iapMetadata, callback)</td>
1930
+ <td style="padding:15px">Retrieve Tracking Settings</td>
1931
+ <td style="padding:15px">{base_path}/{version}/tracking_settings?{query}</td>
1932
+ <td style="padding:15px">Yes</td>
1933
+ </tr>
1934
+ <tr>
1935
+ <td style="padding:15px">getTrackingSettingsClick(iapMetadata, callback)</td>
1936
+ <td style="padding:15px">Retrieve Click Track Settings</td>
1937
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/click?{query}</td>
1938
+ <td style="padding:15px">Yes</td>
1939
+ </tr>
1940
+ <tr>
1941
+ <td style="padding:15px">patchTrackingSettingsClick(body, iapMetadata, callback)</td>
1942
+ <td style="padding:15px">Update Click Tracking Settings</td>
1943
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/click?{query}</td>
1944
+ <td style="padding:15px">Yes</td>
1945
+ </tr>
1946
+ <tr>
1947
+ <td style="padding:15px">getTrackingSettingsGoogleAnalytics(iapMetadata, callback)</td>
1948
+ <td style="padding:15px">Retrieve Google Analytics Settings</td>
1949
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/google_analytics?{query}</td>
1950
+ <td style="padding:15px">Yes</td>
1951
+ </tr>
1952
+ <tr>
1953
+ <td style="padding:15px">patchTrackingSettingsGoogleAnalytics(body, iapMetadata, callback)</td>
1954
+ <td style="padding:15px">Update Google Analytics Settings</td>
1955
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/google_analytics?{query}</td>
1956
+ <td style="padding:15px">Yes</td>
1957
+ </tr>
1958
+ <tr>
1959
+ <td style="padding:15px">getTrackingSettingsOpen(iapMetadata, callback)</td>
1960
+ <td style="padding:15px">Get Open Tracking Settings</td>
1961
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/open?{query}</td>
1962
+ <td style="padding:15px">Yes</td>
1963
+ </tr>
1964
+ <tr>
1965
+ <td style="padding:15px">patchTrackingSettingsOpen(body, iapMetadata, callback)</td>
1966
+ <td style="padding:15px">Update Open Tracking Settings</td>
1967
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/open?{query}</td>
1968
+ <td style="padding:15px">Yes</td>
1969
+ </tr>
1970
+ <tr>
1971
+ <td style="padding:15px">getTrackingSettingsSubscription(iapMetadata, callback)</td>
1972
+ <td style="padding:15px">Retrieve Subscription Tracking Settings</td>
1973
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/subscription?{query}</td>
1974
+ <td style="padding:15px">Yes</td>
1975
+ </tr>
1976
+ <tr>
1977
+ <td style="padding:15px">patchTrackingSettingsSubscription(body, iapMetadata, callback)</td>
1978
+ <td style="padding:15px">Update Subscription Tracking Settings</td>
1979
+ <td style="padding:15px">{base_path}/{version}/tracking_settings/subscription?{query}</td>
1980
+ <td style="padding:15px">Yes</td>
1981
+ </tr>
1982
+ <tr>
1983
+ <td style="padding:15px">getStats(limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
1984
+ <td style="padding:15px">Retrieve global email statistics</td>
1985
+ <td style="padding:15px">{base_path}/{version}/stats?{query}</td>
1986
+ <td style="padding:15px">Yes</td>
1987
+ </tr>
1988
+ <tr>
1989
+ <td style="padding:15px">getGeoStats(country = 'US', limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
1990
+ <td style="padding:15px">Retrieve email statistics by country and state/province.</td>
1991
+ <td style="padding:15px">{base_path}/{version}/geo/stats?{query}</td>
1992
+ <td style="padding:15px">Yes</td>
1993
+ </tr>
1994
+ <tr>
1995
+ <td style="padding:15px">getDevicesStats(limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
1996
+ <td style="padding:15px">Retrieve email statistics by device type.</td>
1997
+ <td style="padding:15px">{base_path}/{version}/devices/stats?{query}</td>
1998
+ <td style="padding:15px">Yes</td>
1999
+ </tr>
2000
+ <tr>
2001
+ <td style="padding:15px">getClientsStats(startDate, endDate, aggregatedBy = 'day', iapMetadata, callback)</td>
2002
+ <td style="padding:15px">Retrieve email statistics by client type.</td>
2003
+ <td style="padding:15px">{base_path}/{version}/clients/stats?{query}</td>
2004
+ <td style="padding:15px">Yes</td>
2005
+ </tr>
2006
+ <tr>
2007
+ <td style="padding:15px">getClientsClientTypeStats(clientType = 'phone', startDate, endDate, aggregatedBy = 'day', iapMetadata, callback)</td>
2008
+ <td style="padding:15px">Retrieve stats by a specific client type.</td>
2009
+ <td style="padding:15px">{base_path}/{version}/clients/{pathv1}/stats?{query}</td>
2010
+ <td style="padding:15px">Yes</td>
2011
+ </tr>
2012
+ <tr>
2013
+ <td style="padding:15px">getMailboxProvidersStats(mailboxProviders, limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
2014
+ <td style="padding:15px">Retrieve email statistics by mailbox provider.</td>
2015
+ <td style="padding:15px">{base_path}/{version}/mailbox_providers/stats?{query}</td>
2016
+ <td style="padding:15px">Yes</td>
2017
+ </tr>
2018
+ <tr>
2019
+ <td style="padding:15px">getBrowsersStats(browsers, limit, offset, aggregatedBy = 'day', startDate, endDate, iapMetadata, callback)</td>
2020
+ <td style="padding:15px">Retrieve email statistics by browser.</td>
2021
+ <td style="padding:15px">{base_path}/{version}/browsers/stats?{query}</td>
2022
+ <td style="padding:15px">Yes</td>
2023
+ </tr>
2024
+ <tr>
2025
+ <td style="padding:15px">getSuppressionBounces(startTime, endTime, iapMetadata, callback)</td>
2026
+ <td style="padding:15px">Retrieve all bounces</td>
2027
+ <td style="padding:15px">{base_path}/{version}/suppression/bounces?{query}</td>
2028
+ <td style="padding:15px">Yes</td>
2029
+ </tr>
2030
+ <tr>
2031
+ <td style="padding:15px">deleteSuppressionBounces(body, iapMetadata, callback)</td>
2032
+ <td style="padding:15px">Delete bounces</td>
2033
+ <td style="padding:15px">{base_path}/{version}/suppression/bounces?{query}</td>
2034
+ <td style="padding:15px">Yes</td>
2035
+ </tr>
2036
+ <tr>
2037
+ <td style="padding:15px">getSuppressionBouncesEmail(email, iapMetadata, callback)</td>
2038
+ <td style="padding:15px">Retrieve a Bounce</td>
2039
+ <td style="padding:15px">{base_path}/{version}/suppression/bounces/{pathv1}?{query}</td>
2040
+ <td style="padding:15px">Yes</td>
2041
+ </tr>
2042
+ <tr>
2043
+ <td style="padding:15px">deleteSuppressionBouncesEmail(email, emailAddress, body, iapMetadata, callback)</td>
2044
+ <td style="padding:15px">Delete a bounce</td>
2045
+ <td style="padding:15px">{base_path}/{version}/suppression/bounces/{pathv1}?{query}</td>
2046
+ <td style="padding:15px">Yes</td>
2047
+ </tr>
2048
+ <tr>
2049
+ <td style="padding:15px">getSuppressionBlocks(startTime, endTime, limit, offset, iapMetadata, callback)</td>
2050
+ <td style="padding:15px">Retrieve all blocks</td>
2051
+ <td style="padding:15px">{base_path}/{version}/suppression/blocks?{query}</td>
2052
+ <td style="padding:15px">Yes</td>
2053
+ </tr>
2054
+ <tr>
2055
+ <td style="padding:15px">deleteSuppressionBlocks(body, iapMetadata, callback)</td>
2056
+ <td style="padding:15px">Delete blocks</td>
2057
+ <td style="padding:15px">{base_path}/{version}/suppression/blocks?{query}</td>
2058
+ <td style="padding:15px">Yes</td>
2059
+ </tr>
2060
+ <tr>
2061
+ <td style="padding:15px">getSuppressionBlocksEmail(email, iapMetadata, callback)</td>
2062
+ <td style="padding:15px">Retrieve a specific block</td>
2063
+ <td style="padding:15px">{base_path}/{version}/suppression/blocks/{pathv1}?{query}</td>
2064
+ <td style="padding:15px">Yes</td>
2065
+ </tr>
2066
+ <tr>
2067
+ <td style="padding:15px">deleteSuppressionBlocksEmail(email, iapMetadata, callback)</td>
2068
+ <td style="padding:15px">Delete a specific block</td>
2069
+ <td style="padding:15px">{base_path}/{version}/suppression/blocks/{pathv1}?{query}</td>
2070
+ <td style="padding:15px">Yes</td>
2071
+ </tr>
2072
+ <tr>
2073
+ <td style="padding:15px">getSuppressionSpamReports(startTime, endTime, limit, offset, iapMetadata, callback)</td>
2074
+ <td style="padding:15px">Retrieve all spam reports</td>
2075
+ <td style="padding:15px">{base_path}/{version}/suppression/spam_reports?{query}</td>
2076
+ <td style="padding:15px">Yes</td>
2077
+ </tr>
2078
+ <tr>
2079
+ <td style="padding:15px">deleteSuppressionSpamReports(body, iapMetadata, callback)</td>
2080
+ <td style="padding:15px">Delete spam reports</td>
2081
+ <td style="padding:15px">{base_path}/{version}/suppression/spam_reports?{query}</td>
2082
+ <td style="padding:15px">Yes</td>
2083
+ </tr>
2084
+ <tr>
2085
+ <td style="padding:15px">getSuppressionSpamReportsEmail(email, iapMetadata, callback)</td>
2086
+ <td style="padding:15px">Retrieve a specific spam report</td>
2087
+ <td style="padding:15px">{base_path}/{version}/suppression/spam_reports/{pathv1}?{query}</td>
2088
+ <td style="padding:15px">Yes</td>
2089
+ </tr>
2090
+ <tr>
2091
+ <td style="padding:15px">deleteSuppressionSpamReportsEmail(email, iapMetadata, callback)</td>
2092
+ <td style="padding:15px">Delete a specific spam report</td>
2093
+ <td style="padding:15px">{base_path}/{version}/suppression/spam_reports/{pathv1}?{query}</td>
2094
+ <td style="padding:15px">Yes</td>
2095
+ </tr>
2096
+ <tr>
2097
+ <td style="padding:15px">postAsmSuppressionsGlobal(body, iapMetadata, callback)</td>
2098
+ <td style="padding:15px">Add recipient addresses to the global suppression group.</td>
2099
+ <td style="padding:15px">{base_path}/{version}/asm/suppressions/global?{query}</td>
2100
+ <td style="padding:15px">Yes</td>
2101
+ </tr>
2102
+ <tr>
2103
+ <td style="padding:15px">getSuppressionUnsubscribes(startTime, endTime, limit, offset, iapMetadata, callback)</td>
2104
+ <td style="padding:15px">Retrieve all global suppressions</td>
2105
+ <td style="padding:15px">{base_path}/{version}/suppression/unsubscribes?{query}</td>
2106
+ <td style="padding:15px">Yes</td>
2107
+ </tr>
2108
+ <tr>
2109
+ <td style="padding:15px">getAsmSuppressionsGlobalEmail(email, iapMetadata, callback)</td>
2110
+ <td style="padding:15px">Retrieve a Global Suppression</td>
2111
+ <td style="padding:15px">{base_path}/{version}/asm/suppressions/global/{pathv1}?{query}</td>
2112
+ <td style="padding:15px">Yes</td>
2113
+ </tr>
2114
+ <tr>
2115
+ <td style="padding:15px">deleteAsmSuppressionsGlobalEmail(email, iapMetadata, callback)</td>
2116
+ <td style="padding:15px">Delete a Global Suppression</td>
2117
+ <td style="padding:15px">{base_path}/{version}/asm/suppressions/global/{pathv1}?{query}</td>
2118
+ <td style="padding:15px">Yes</td>
2119
+ </tr>
2120
+ <tr>
2121
+ <td style="padding:15px">postAsmGroups(body, iapMetadata, callback)</td>
2122
+ <td style="padding:15px">Create a new suppression group</td>
2123
+ <td style="padding:15px">{base_path}/{version}/asm/groups?{query}</td>
2124
+ <td style="padding:15px">Yes</td>
2125
+ </tr>
2126
+ <tr>
2127
+ <td style="padding:15px">getAsmGroups(id, iapMetadata, callback)</td>
2128
+ <td style="padding:15px">Retrieve all suppression groups associated with the user.</td>
2129
+ <td style="padding:15px">{base_path}/{version}/asm/groups?{query}</td>
2130
+ <td style="padding:15px">Yes</td>
2131
+ </tr>
2132
+ <tr>
2133
+ <td style="padding:15px">getAsmGroupsGroupId(groupId, iapMetadata, callback)</td>
2134
+ <td style="padding:15px">Get information on a single suppression group.</td>
2135
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}?{query}</td>
2136
+ <td style="padding:15px">Yes</td>
2137
+ </tr>
2138
+ <tr>
2139
+ <td style="padding:15px">patchAsmGroupsGroupId(groupId, body, iapMetadata, callback)</td>
2140
+ <td style="padding:15px">Update a suppression group.</td>
2141
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}?{query}</td>
2142
+ <td style="padding:15px">Yes</td>
2143
+ </tr>
2144
+ <tr>
2145
+ <td style="padding:15px">deleteAsmGroupsGroupId(groupId, iapMetadata, callback)</td>
2146
+ <td style="padding:15px">Delete a Suppression Group</td>
2147
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}?{query}</td>
2148
+ <td style="padding:15px">Yes</td>
2149
+ </tr>
2150
+ <tr>
2151
+ <td style="padding:15px">postAsmGroupsGroupIdSuppressions(groupId, body, iapMetadata, callback)</td>
2152
+ <td style="padding:15px">Add suppressions to a suppression group</td>
2153
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}/suppressions?{query}</td>
2154
+ <td style="padding:15px">Yes</td>
2155
+ </tr>
2156
+ <tr>
2157
+ <td style="padding:15px">getAsmGroupsGroupIdSuppressions(groupId, iapMetadata, callback)</td>
2158
+ <td style="padding:15px">Retrieve all suppressions for a suppression group</td>
2159
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}/suppressions?{query}</td>
2160
+ <td style="padding:15px">Yes</td>
2161
+ </tr>
2162
+ <tr>
2163
+ <td style="padding:15px">postAsmGroupsGroupIdSuppressionsSearch(groupId, body, iapMetadata, callback)</td>
2164
+ <td style="padding:15px">Search for suppressions within a group</td>
2165
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}/suppressions/search?{query}</td>
2166
+ <td style="padding:15px">Yes</td>
2167
+ </tr>
2168
+ <tr>
2169
+ <td style="padding:15px">getAsmSuppressions(iapMetadata, callback)</td>
2170
+ <td style="padding:15px">Retrieve all suppressions</td>
2171
+ <td style="padding:15px">{base_path}/{version}/asm/suppressions?{query}</td>
2172
+ <td style="padding:15px">Yes</td>
2173
+ </tr>
2174
+ <tr>
2175
+ <td style="padding:15px">getAsmSuppressionsEmail(email, iapMetadata, callback)</td>
2176
+ <td style="padding:15px">Retrieve all suppression groups for an email address</td>
2177
+ <td style="padding:15px">{base_path}/{version}/asm/suppressions/{pathv1}?{query}</td>
2178
+ <td style="padding:15px">Yes</td>
2179
+ </tr>
2180
+ <tr>
2181
+ <td style="padding:15px">deleteAsmGroupsGroupIdSuppressionsEmail(groupId, email, iapMetadata, callback)</td>
2182
+ <td style="padding:15px">Delete a suppression from a suppression group</td>
2183
+ <td style="padding:15px">{base_path}/{version}/asm/groups/{pathv1}/suppressions/{pathv2}?{query}</td>
2184
+ <td style="padding:15px">Yes</td>
2185
+ </tr>
2186
+ <tr>
2187
+ <td style="padding:15px">getSuppressionInvalidEmails(startTime, endTime, limit, offset, iapMetadata, callback)</td>
2188
+ <td style="padding:15px">Retrieve all invalid emails</td>
2189
+ <td style="padding:15px">{base_path}/{version}/suppression/invalid_emails?{query}</td>
2190
+ <td style="padding:15px">Yes</td>
2191
+ </tr>
2192
+ <tr>
2193
+ <td style="padding:15px">deleteSuppressionInvalidEmails(body, iapMetadata, callback)</td>
2194
+ <td style="padding:15px">Delete invalid emails</td>
2195
+ <td style="padding:15px">{base_path}/{version}/suppression/invalid_emails?{query}</td>
2196
+ <td style="padding:15px">Yes</td>
2197
+ </tr>
2198
+ <tr>
2199
+ <td style="padding:15px">getSuppressionInvalidEmailsEmail(email, iapMetadata, callback)</td>
2200
+ <td style="padding:15px">Retrieve a specific invalid email</td>
2201
+ <td style="padding:15px">{base_path}/{version}/suppression/invalid_emails/{pathv1}?{query}</td>
2202
+ <td style="padding:15px">Yes</td>
2203
+ </tr>
2204
+ <tr>
2205
+ <td style="padding:15px">deleteSuppressionInvalidEmailsEmail(email, iapMetadata, callback)</td>
2206
+ <td style="padding:15px">Delete a specific invalid email</td>
2207
+ <td style="padding:15px">{base_path}/{version}/suppression/invalid_emails/{pathv1}?{query}</td>
2208
+ <td style="padding:15px">Yes</td>
2209
+ </tr>
2210
+ </table>
2211
+ <br>