@itentialopensource/adapter-salesforce 0.7.4 → 0.9.0
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.
- package/AUTH.md +39 -0
- package/BROKER.md +199 -0
- package/CALLS.md +454 -0
- package/CHANGELOG.md +49 -29
- package/CODE_OF_CONDUCT.md +12 -17
- package/CONTRIBUTING.md +3 -148
- package/ENHANCE.md +69 -0
- package/PROPERTIES.md +641 -0
- package/README.md +239 -507
- package/SUMMARY.md +9 -0
- package/SYSTEMINFO.md +11 -0
- package/TROUBLESHOOT.md +47 -0
- package/adapter.js +423 -304
- package/adapterBase.js +854 -408
- package/changelogs/changelog.md +94 -0
- package/entities/.generic/action.json +110 -5
- package/entities/.generic/schema.json +6 -1
- package/entities/.system/action.json +4 -4
- package/entities/.system/schemaTokenReq.json +33 -4
- package/entities/.system/schemaTokenResp.json +1 -34
- package/error.json +12 -0
- package/metadata.json +49 -0
- package/package.json +28 -22
- package/pronghorn.json +691 -88
- package/propertiesDecorators.json +14 -0
- package/propertiesSchema.json +842 -6
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +1543 -0
- package/report/adapter-openapi.yaml +1201 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1653403992147.json +120 -0
- package/report/updateReport1691511372644.json +120 -0
- package/report/updateReport1692202876451.json +120 -0
- package/report/updateReport1694464610053.json +120 -0
- package/report/updateReport1698421735618.json +120 -0
- package/sampleProperties.json +156 -3
- package/test/integration/adapterTestBasicGet.js +4 -6
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +158 -104
- package/test/unit/adapterBaseTestUnit.js +393 -310
- package/test/unit/adapterTestUnit.js +833 -209
- package/utils/adapterInfo.js +206 -0
- package/utils/addAuth.js +94 -0
- package/utils/artifactize.js +1 -1
- package/utils/basicGet.js +1 -14
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +179 -0
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +273 -0
- package/utils/modify.js +14 -16
- package/utils/packModificationScript.js +2 -2
- package/utils/patches2bundledDeps.js +90 -0
- package/utils/pre-commit.sh +5 -0
- package/utils/removeHooks.js +20 -0
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +129 -53
- package/utils/tbUtils.js +152 -35
- package/utils/testRunner.js +17 -17
- package/utils/troubleshootingAdapter.js +10 -31
- package/workflows/README.md +0 -3
package/CALLS.md
ADDED
|
@@ -0,0 +1,454 @@
|
|
|
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 Salesforce. 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 Salesforce.</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">iapFindAdapterPath(apiPath, callback)</td>
|
|
42
|
+
<td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
|
|
43
|
+
<td style="padding:15px">Yes</td>
|
|
44
|
+
</tr>
|
|
45
|
+
<tr>
|
|
46
|
+
<td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
|
|
47
|
+
<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>
|
|
48
|
+
<td style="padding:15px">Yes</td>
|
|
49
|
+
</tr>
|
|
50
|
+
<tr>
|
|
51
|
+
<td style="padding:15px">iapUnsuspendAdapter(callback)</td>
|
|
52
|
+
<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>
|
|
53
|
+
<td style="padding:15px">Yes</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr>
|
|
56
|
+
<td style="padding:15px">iapGetAdapterQueue(callback)</td>
|
|
57
|
+
<td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</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
|
+
|
|
66
|
+
<tr>
|
|
67
|
+
<td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
|
|
68
|
+
<td style="padding:15px">This call will return the results of a healthcheck.</td>
|
|
69
|
+
<td style="padding:15px">Yes</td>
|
|
70
|
+
</tr>
|
|
71
|
+
<tr>
|
|
72
|
+
<td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
|
|
73
|
+
<td style="padding:15px">This call will return the results of a connectivity check.</td>
|
|
74
|
+
<td style="padding:15px">Yes</td>
|
|
75
|
+
</tr>
|
|
76
|
+
<tr>
|
|
77
|
+
<td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
|
|
78
|
+
<td style="padding:15px">This call will return the results of running basic get API calls.</td>
|
|
79
|
+
<td style="padding:15px">Yes</td>
|
|
80
|
+
</tr>
|
|
81
|
+
<tr>
|
|
82
|
+
<td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
|
|
83
|
+
<td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
|
|
84
|
+
<td style="padding:15px">Yes</td>
|
|
85
|
+
</tr>
|
|
86
|
+
<tr>
|
|
87
|
+
<td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
|
|
88
|
+
<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>
|
|
89
|
+
<td style="padding:15px">Yes</td>
|
|
90
|
+
</tr>
|
|
91
|
+
<tr>
|
|
92
|
+
<td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
|
|
93
|
+
<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>
|
|
94
|
+
<td style="padding:15px">Yes</td>
|
|
95
|
+
</tr>
|
|
96
|
+
<tr>
|
|
97
|
+
<td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
|
|
98
|
+
<td style="padding:15px">This call verifies the adapter has the specific entity.</td>
|
|
99
|
+
<td style="padding:15px">No</td>
|
|
100
|
+
</tr>
|
|
101
|
+
<tr>
|
|
102
|
+
<td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
|
|
103
|
+
<td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
|
|
104
|
+
<td style="padding:15px">No</td>
|
|
105
|
+
</tr>
|
|
106
|
+
<tr>
|
|
107
|
+
<td style="padding:15px">iapUpdateAdapterEntityCache()</td>
|
|
108
|
+
<td style="padding:15px">This call will update the entity cache.</td>
|
|
109
|
+
<td style="padding:15px">No</td>
|
|
110
|
+
</tr>
|
|
111
|
+
</table>
|
|
112
|
+
<br>
|
|
113
|
+
|
|
114
|
+
### Adapter Broker Calls
|
|
115
|
+
|
|
116
|
+
These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
|
|
117
|
+
|
|
118
|
+
<table border="1" class="bordered-table">
|
|
119
|
+
<tr>
|
|
120
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
|
|
121
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
122
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
123
|
+
</tr>
|
|
124
|
+
<tr>
|
|
125
|
+
<td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
|
|
126
|
+
<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>
|
|
127
|
+
<td style="padding:15px">No</td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr>
|
|
130
|
+
<td style="padding:15px">getDevice(deviceName, callback)</td>
|
|
131
|
+
<td style="padding:15px">This call returns the details of the requested device.</td>
|
|
132
|
+
<td style="padding:15px">Yes</td>
|
|
133
|
+
</tr>
|
|
134
|
+
<tr>
|
|
135
|
+
<td style="padding:15px">getDevicesFiltered(options, callback)</td>
|
|
136
|
+
<td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
|
|
137
|
+
<td style="padding:15px">Yes</td>
|
|
138
|
+
</tr>
|
|
139
|
+
<tr>
|
|
140
|
+
<td style="padding:15px">isAlive(deviceName, callback)</td>
|
|
141
|
+
<td style="padding:15px">This call returns whether the device status is active</td>
|
|
142
|
+
<td style="padding:15px">Yes</td>
|
|
143
|
+
</tr>
|
|
144
|
+
<tr>
|
|
145
|
+
<td style="padding:15px">getConfig(deviceName, format, callback)</td>
|
|
146
|
+
<td style="padding:15px">This call returns the configuration for the selected device.</td>
|
|
147
|
+
<td style="padding:15px">Yes</td>
|
|
148
|
+
</tr>
|
|
149
|
+
<tr>
|
|
150
|
+
<td style="padding:15px">iapGetDeviceCount(callback)</td>
|
|
151
|
+
<td style="padding:15px">This call returns the count of devices.</td>
|
|
152
|
+
<td style="padding:15px">Yes</td>
|
|
153
|
+
</tr>
|
|
154
|
+
</table>
|
|
155
|
+
<br>
|
|
156
|
+
|
|
157
|
+
### Specific Adapter Calls
|
|
158
|
+
|
|
159
|
+
Specific adapter calls are built based on the API of the Salesforce. 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.
|
|
160
|
+
|
|
161
|
+
<table border="1" class="bordered-table">
|
|
162
|
+
<tr>
|
|
163
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
|
|
164
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
|
|
165
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
|
|
166
|
+
<th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
|
|
167
|
+
</tr>
|
|
168
|
+
<tr>
|
|
169
|
+
<td style="padding:15px">getLocalizations(locale, callback)</td>
|
|
170
|
+
<td style="padding:15px">Returns object of localized text</td>
|
|
171
|
+
<td style="padding:15px">{base_path}/{version}/localizations?{query}</td>
|
|
172
|
+
<td style="padding:15px">Yes</td>
|
|
173
|
+
</tr>
|
|
174
|
+
<tr>
|
|
175
|
+
<td style="padding:15px">getIncidents(startTime, service, instance, limit, offset, sort, order, locale, callback)</td>
|
|
176
|
+
<td style="padding:15px">Returns an array of Incident objects. Defaults to last 30 days.</td>
|
|
177
|
+
<td style="padding:15px">{base_path}/{version}/incidents?{query}</td>
|
|
178
|
+
<td style="padding:15px">Yes</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td style="padding:15px">getIncidentsid(id, locale, callback)</td>
|
|
182
|
+
<td style="padding:15px">Returns an Incident based on Id.</td>
|
|
183
|
+
<td style="padding:15px">{base_path}/{version}/incidents/{pathv1}?{query}</td>
|
|
184
|
+
<td style="padding:15px">Yes</td>
|
|
185
|
+
</tr>
|
|
186
|
+
<tr>
|
|
187
|
+
<td style="padding:15px">getIncidentsfields(locale, callback)</td>
|
|
188
|
+
<td style="padding:15px">Returns an array of Incident fields.</td>
|
|
189
|
+
<td style="padding:15px">{base_path}/{version}/incidents/fields?{query}</td>
|
|
190
|
+
<td style="padding:15px">Yes</td>
|
|
191
|
+
</tr>
|
|
192
|
+
<tr>
|
|
193
|
+
<td style="padding:15px">getIncidentsimpactTypes(locale, callback)</td>
|
|
194
|
+
<td style="padding:15px">Returns an array of incident imapct type fields.</td>
|
|
195
|
+
<td style="padding:15px">{base_path}/{version}/incidents/impactTypes?{query}</td>
|
|
196
|
+
<td style="padding:15px">Yes</td>
|
|
197
|
+
</tr>
|
|
198
|
+
<tr>
|
|
199
|
+
<td style="padding:15px">getIncidentseventTypes(locale, callback)</td>
|
|
200
|
+
<td style="padding:15px">Returns an array of incident imapct type fields.</td>
|
|
201
|
+
<td style="padding:15px">{base_path}/{version}/incidents/eventTypes?{query}</td>
|
|
202
|
+
<td style="padding:15px">Yes</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td style="padding:15px">getMaintenances(startTime, service, instance, name, limit, offset, sort, order, locale, callback)</td>
|
|
206
|
+
<td style="padding:15px">Returns an array of Maintenance objects. Defaults to last 30 days.</td>
|
|
207
|
+
<td style="padding:15px">{base_path}/{version}/maintenances?{query}</td>
|
|
208
|
+
<td style="padding:15px">Yes</td>
|
|
209
|
+
</tr>
|
|
210
|
+
<tr>
|
|
211
|
+
<td style="padding:15px">getMaintenancesid(id, locale, callback)</td>
|
|
212
|
+
<td style="padding:15px">Returns a Maintenance based on Id.</td>
|
|
213
|
+
<td style="padding:15px">{base_path}/{version}/maintenances/{pathv1}?{query}</td>
|
|
214
|
+
<td style="padding:15px">Yes</td>
|
|
215
|
+
</tr>
|
|
216
|
+
<tr>
|
|
217
|
+
<td style="padding:15px">getMaintenancesfields(locale, callback)</td>
|
|
218
|
+
<td style="padding:15px">Returns an array of Maintenance fields.</td>
|
|
219
|
+
<td style="padding:15px">{base_path}/{version}/maintenances/fields?{query}</td>
|
|
220
|
+
<td style="padding:15px">Yes</td>
|
|
221
|
+
</tr>
|
|
222
|
+
<tr>
|
|
223
|
+
<td style="padding:15px">getMaintenanceseventTypes(locale, callback)</td>
|
|
224
|
+
<td style="padding:15px">Returns an array of maintenance imapct type fields.</td>
|
|
225
|
+
<td style="padding:15px">{base_path}/{version}/maintenances/eventTypes?{query}</td>
|
|
226
|
+
<td style="padding:15px">Yes</td>
|
|
227
|
+
</tr>
|
|
228
|
+
<tr>
|
|
229
|
+
<td style="padding:15px">getGeneralMessages(limit, offset, callback)</td>
|
|
230
|
+
<td style="padding:15px">Returns an array of GeneralMessage objects.</td>
|
|
231
|
+
<td style="padding:15px">{base_path}/{version}/generalMessages?{query}</td>
|
|
232
|
+
<td style="padding:15px">Yes</td>
|
|
233
|
+
</tr>
|
|
234
|
+
<tr>
|
|
235
|
+
<td style="padding:15px">getGeneralMessagesid(id, callback)</td>
|
|
236
|
+
<td style="padding:15px">Returns a GeneralMessage based on Id.</td>
|
|
237
|
+
<td style="padding:15px">{base_path}/{version}/generalMessages/{pathv1}?{query}</td>
|
|
238
|
+
<td style="padding:15px">Yes</td>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr>
|
|
241
|
+
<td style="padding:15px">getMetricValues(startTime, endTime, metricName, instanceKey, callback)</td>
|
|
242
|
+
<td style="padding:15px">Returns an array of MetricValue objects.</td>
|
|
243
|
+
<td style="padding:15px">{base_path}/{version}/metricValues?{query}</td>
|
|
244
|
+
<td style="padding:15px">Yes</td>
|
|
245
|
+
</tr>
|
|
246
|
+
<tr>
|
|
247
|
+
<td style="padding:15px">getMetricValuesid(id, callback)</td>
|
|
248
|
+
<td style="padding:15px">Returns a MetricValue based on Id.</td>
|
|
249
|
+
<td style="padding:15px">{base_path}/{version}/metricValues/{pathv1}?{query}</td>
|
|
250
|
+
<td style="padding:15px">Yes</td>
|
|
251
|
+
</tr>
|
|
252
|
+
<tr>
|
|
253
|
+
<td style="padding:15px">getLocales(locale, callback)</td>
|
|
254
|
+
<td style="padding:15px">Return all locales</td>
|
|
255
|
+
<td style="padding:15px">{base_path}/{version}/locales?{query}</td>
|
|
256
|
+
<td style="padding:15px">Yes</td>
|
|
257
|
+
</tr>
|
|
258
|
+
<tr>
|
|
259
|
+
<td style="padding:15px">getServices(locale, callback)</td>
|
|
260
|
+
<td style="padding:15px">Return all locales</td>
|
|
261
|
+
<td style="padding:15px">{base_path}/{version}/services?{query}</td>
|
|
262
|
+
<td style="padding:15px">Yes</td>
|
|
263
|
+
</tr>
|
|
264
|
+
<tr>
|
|
265
|
+
<td style="padding:15px">getInstances(sort, order, products, tags, childProducts, locale, callback)</td>
|
|
266
|
+
<td style="padding:15px">Return all locales</td>
|
|
267
|
+
<td style="padding:15px">{base_path}/{version}/instances?{query}</td>
|
|
268
|
+
<td style="padding:15px">Yes</td>
|
|
269
|
+
</tr>
|
|
270
|
+
<tr>
|
|
271
|
+
<td style="padding:15px">getInstancesstatus(products, childProducts, locale, callback)</td>
|
|
272
|
+
<td style="padding:15px">DEPRECATED WARNING ROUTE WILL BE REMOVED
|
|
273
|
+
Use /instance/status/preview for overall current status and
|
|
274
|
+
currently ongoing incidents, maintenances, and general messages.
|
|
275
|
+
Use /instances/{key}/status for current status and recent
|
|
276
|
+
history of incidents, maintenances, and general messages for
|
|
277
|
+
sepcific instance
|
|
278
|
+
|
|
279
|
+
Return all instances and associated incidents</td>
|
|
280
|
+
<td style="padding:15px">{base_path}/{version}/instances/status?{query}</td>
|
|
281
|
+
<td style="padding:15px">Yes</td>
|
|
282
|
+
</tr>
|
|
283
|
+
<tr>
|
|
284
|
+
<td style="padding:15px">getInstancesstatuspreview(products, childProducts, locale, callback)</td>
|
|
285
|
+
<td style="padding:15px">Return all instances and associated incidents, maintenances, and general messages.
|
|
286
|
+
For each instance returns a state enum indicating the most
|
|
287
|
+
severe ongoing event, and if it effects a core service.
|
|
288
|
+
|
|
289
|
+
Status Enums
|
|
290
|
+
* OK
|
|
291
|
+
* MAJOR_INCIDENT_CORE
|
|
292
|
+
* MINOR_INCIDENT_CORE
|
|
293
|
+
* MAINTENANCE_CORE
|
|
294
|
+
* MAJOR_INCIDENT_NONCORE
|
|
295
|
+
* MINOR_INCIDENT_NONCORE
|
|
296
|
+
* MAINTENANCE_NONCORE</td>
|
|
297
|
+
<td style="padding:15px">{base_path}/{version}/instances/status/preview?{query}</td>
|
|
298
|
+
<td style="padding:15px">Yes</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td style="padding:15px">getInstanceskeystatuspreview(key, productKey, childProducts, locale, callback)</td>
|
|
302
|
+
<td style="padding:15px">Rerurn an instance with associated incidents, maintenances, and general messages.
|
|
303
|
+
For a given instance returns a state enum indicating the most
|
|
304
|
+
severe ongoing event, and if it effects a core service.
|
|
305
|
+
|
|
306
|
+
Status Enums
|
|
307
|
+
* OK
|
|
308
|
+
* MAJOR_INCIDENT_CORE
|
|
309
|
+
* MINOR_INCIDENT_CORE
|
|
310
|
+
* MAINTENANCE_CORE
|
|
311
|
+
* MAJOR_INCIDENT_NONCORE
|
|
312
|
+
* MINOR_INCIDENT_NONCORE
|
|
313
|
+
* MAINTENANCE_NONCORE</td>
|
|
314
|
+
<td style="padding:15px">{base_path}/{version}/instances/{pathv1}/status/preview?{query}</td>
|
|
315
|
+
<td style="padding:15px">Yes</td>
|
|
316
|
+
</tr>
|
|
317
|
+
<tr>
|
|
318
|
+
<td style="padding:15px">getInstanceskeystatus(key, productKey, childProducts, locale, callback)</td>
|
|
319
|
+
<td style="padding:15px">Return an by instance with associated incidents, maintenances, and general messages.
|
|
320
|
+
Returns a state enum indicating the most
|
|
321
|
+
severe ongoing event, and if it effects a core service.
|
|
322
|
+
|
|
323
|
+
Status Enums:
|
|
324
|
+
* OK
|
|
325
|
+
* MAJOR_INCIDENT_CORE
|
|
326
|
+
* MINOR_INCIDENT_CORE
|
|
327
|
+
* MAINTENANCE_CORE
|
|
328
|
+
* MAJOR_INCIDENT_NONCORE
|
|
329
|
+
* MINOR_INCIDENT_NONCORE
|
|
330
|
+
* MAINTENANCE_NONCORE</td>
|
|
331
|
+
<td style="padding:15px">{base_path}/{version}/instances/{pathv1}/status?{query}</td>
|
|
332
|
+
<td style="padding:15px">Yes</td>
|
|
333
|
+
</tr>
|
|
334
|
+
<tr>
|
|
335
|
+
<td style="padding:15px">getInstanceAliaseskeystatus(key, callback)</td>
|
|
336
|
+
<td style="padding:15px">Return an by instance with associated incidents, maintenances, and general messages.
|
|
337
|
+
Returns a state enum indicating the most
|
|
338
|
+
severe ongoing event, and if it effects a core service.
|
|
339
|
+
|
|
340
|
+
Status Enums:
|
|
341
|
+
* OK
|
|
342
|
+
* MAJOR_INCIDENT_CORE
|
|
343
|
+
* MINOR_INCIDENT_CORE
|
|
344
|
+
* MAINTENANCE_CORE
|
|
345
|
+
* MAJOR_INCIDENT_NONCORE
|
|
346
|
+
* MINOR_INCIDENT_NONCORE
|
|
347
|
+
* MAINTENANCE_NONCORE</td>
|
|
348
|
+
<td style="padding:15px">{base_path}/{version}/instanceAliases/{pathv1}/status?{query}</td>
|
|
349
|
+
<td style="padding:15px">Yes</td>
|
|
350
|
+
</tr>
|
|
351
|
+
<tr>
|
|
352
|
+
<td style="padding:15px">getInstanceAliaseskey(key, callback)</td>
|
|
353
|
+
<td style="padding:15px">Get Instance Alias</td>
|
|
354
|
+
<td style="padding:15px">{base_path}/{version}/instanceAliases/{pathv1}?{query}</td>
|
|
355
|
+
<td style="padding:15px">Yes</td>
|
|
356
|
+
</tr>
|
|
357
|
+
<tr>
|
|
358
|
+
<td style="padding:15px">getProducts(callback)</td>
|
|
359
|
+
<td style="padding:15px">Return all catergories</td>
|
|
360
|
+
<td style="padding:15px">{base_path}/{version}/products?{query}</td>
|
|
361
|
+
<td style="padding:15px">Yes</td>
|
|
362
|
+
</tr>
|
|
363
|
+
<tr>
|
|
364
|
+
<td style="padding:15px">getProductskey(key, callback)</td>
|
|
365
|
+
<td style="padding:15px">Returns an product by id.</td>
|
|
366
|
+
<td style="padding:15px">{base_path}/{version}/products/{pathv1}?{query}</td>
|
|
367
|
+
<td style="padding:15px">Yes</td>
|
|
368
|
+
</tr>
|
|
369
|
+
<tr>
|
|
370
|
+
<td style="padding:15px">postSubscribe(XSendNotification, body, callback)</td>
|
|
371
|
+
<td style="padding:15px"></td>
|
|
372
|
+
<td style="padding:15px">{base_path}/{version}/subscribe?{query}</td>
|
|
373
|
+
<td style="padding:15px">Yes</td>
|
|
374
|
+
</tr>
|
|
375
|
+
<tr>
|
|
376
|
+
<td style="padding:15px">patchUnsubscribe(body, token, callback)</td>
|
|
377
|
+
<td style="padding:15px"></td>
|
|
378
|
+
<td style="padding:15px">{base_path}/{version}/unsubscribe?{query}</td>
|
|
379
|
+
<td style="padding:15px">Yes</td>
|
|
380
|
+
</tr>
|
|
381
|
+
<tr>
|
|
382
|
+
<td style="padding:15px">postUnsubscribe(body, token, callback)</td>
|
|
383
|
+
<td style="padding:15px"></td>
|
|
384
|
+
<td style="padding:15px">{base_path}/{version}/unsubscribe?{query}</td>
|
|
385
|
+
<td style="padding:15px">Yes</td>
|
|
386
|
+
</tr>
|
|
387
|
+
<tr>
|
|
388
|
+
<td style="padding:15px">postLogin(XSendNotification, body, callback)</td>
|
|
389
|
+
<td style="padding:15px">Requests to send a login link to the email address</td>
|
|
390
|
+
<td style="padding:15px">{base_path}/{version}/login?{query}</td>
|
|
391
|
+
<td style="padding:15px">Yes</td>
|
|
392
|
+
</tr>
|
|
393
|
+
<tr>
|
|
394
|
+
<td style="padding:15px">getLogout(token, callback)</td>
|
|
395
|
+
<td style="padding:15px">Logout authenticated user.</td>
|
|
396
|
+
<td style="padding:15px">{base_path}/{version}/logout?{query}</td>
|
|
397
|
+
<td style="padding:15px">Yes</td>
|
|
398
|
+
</tr>
|
|
399
|
+
<tr>
|
|
400
|
+
<td style="padding:15px">getSubscribers(token, normalize, callback)</td>
|
|
401
|
+
<td style="padding:15px">Retrieve Subscriber</td>
|
|
402
|
+
<td style="padding:15px">{base_path}/{version}/subscribers?{query}</td>
|
|
403
|
+
<td style="padding:15px">Yes</td>
|
|
404
|
+
</tr>
|
|
405
|
+
<tr>
|
|
406
|
+
<td style="padding:15px">patchSubscribers(XSendNotification, token, body, callback)</td>
|
|
407
|
+
<td style="padding:15px">Update Subscriber</td>
|
|
408
|
+
<td style="padding:15px">{base_path}/{version}/subscribers?{query}</td>
|
|
409
|
+
<td style="padding:15px">Yes</td>
|
|
410
|
+
</tr>
|
|
411
|
+
<tr>
|
|
412
|
+
<td style="padding:15px">postSubscriberssubscriptionsid(id, token, body, callback)</td>
|
|
413
|
+
<td style="padding:15px">Creates a Subscription for the User.</td>
|
|
414
|
+
<td style="padding:15px">{base_path}/{version}/subscribers/subscriptions/{pathv1}?{query}</td>
|
|
415
|
+
<td style="padding:15px">Yes</td>
|
|
416
|
+
</tr>
|
|
417
|
+
<tr>
|
|
418
|
+
<td style="padding:15px">patchSubscriberssubscriptionsid(id, token, body, callback)</td>
|
|
419
|
+
<td style="padding:15px">Updates a Subscription for the User.</td>
|
|
420
|
+
<td style="padding:15px">{base_path}/{version}/subscribers/subscriptions/{pathv1}?{query}</td>
|
|
421
|
+
<td style="padding:15px">Yes</td>
|
|
422
|
+
</tr>
|
|
423
|
+
<tr>
|
|
424
|
+
<td style="padding:15px">deleteSubscriberssubscriptionsid(id, token, body, callback)</td>
|
|
425
|
+
<td style="padding:15px">Deletes a Subscription for the User.</td>
|
|
426
|
+
<td style="padding:15px">{base_path}/{version}/subscribers/subscriptions/{pathv1}?{query}</td>
|
|
427
|
+
<td style="padding:15px">Yes</td>
|
|
428
|
+
</tr>
|
|
429
|
+
<tr>
|
|
430
|
+
<td style="padding:15px">getSearchkey(key, callback)</td>
|
|
431
|
+
<td style="padding:15px">Return all search results</td>
|
|
432
|
+
<td style="padding:15px">{base_path}/{version}/search/{pathv1}?{query}</td>
|
|
433
|
+
<td style="padding:15px">Yes</td>
|
|
434
|
+
</tr>
|
|
435
|
+
<tr>
|
|
436
|
+
<td style="padding:15px">getTags(callback)</td>
|
|
437
|
+
<td style="padding:15px">Return all the tags</td>
|
|
438
|
+
<td style="padding:15px">{base_path}/{version}/tags?{query}</td>
|
|
439
|
+
<td style="padding:15px">Yes</td>
|
|
440
|
+
</tr>
|
|
441
|
+
<tr>
|
|
442
|
+
<td style="padding:15px">getTagsinstanceinstanceKey(instanceKey, instances, callback)</td>
|
|
443
|
+
<td style="padding:15px">Return all the tags for a given Instance Key</td>
|
|
444
|
+
<td style="padding:15px">{base_path}/{version}/tags/instance/{pathv1}?{query}</td>
|
|
445
|
+
<td style="padding:15px">Yes</td>
|
|
446
|
+
</tr>
|
|
447
|
+
<tr>
|
|
448
|
+
<td style="padding:15px">getTagTypes(callback)</td>
|
|
449
|
+
<td style="padding:15px">Return all the tag types</td>
|
|
450
|
+
<td style="padding:15px">{base_path}/{version}/tagTypes?{query}</td>
|
|
451
|
+
<td style="padding:15px">Yes</td>
|
|
452
|
+
</tr>
|
|
453
|
+
</table>
|
|
454
|
+
<br>
|
package/CHANGELOG.md
CHANGED
|
@@ -1,7 +1,35 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.9.0 [12-31-2023]
|
|
3
|
+
|
|
4
|
+
* Adapter Engine has been updated and the changes are being migrated to the adapter
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!9
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 0.8.0 [05-25-2022]
|
|
11
|
+
|
|
12
|
+
* Migration to the latest Adapter Foundation
|
|
13
|
+
|
|
14
|
+
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!8
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
2
18
|
## 0.7.4 [03-13-2021]
|
|
3
19
|
|
|
4
|
-
|
|
20
|
+
- Migration to bring up to the latest foundation
|
|
21
|
+
- Change to .eslintignore (adapter_modification directory)
|
|
22
|
+
- Change to README.md (new properties, new scripts, new processes)
|
|
23
|
+
- Changes to adapterBase.js (new methods)
|
|
24
|
+
- Changes to package.json (new scripts, dependencies)
|
|
25
|
+
- Changes to propertiesSchema.json (new properties and changes to existing)
|
|
26
|
+
- Changes to the Unit test
|
|
27
|
+
- Adding several test files, utils files and .generic entity
|
|
28
|
+
- Fix order of scripts and dependencies in package.json
|
|
29
|
+
- Fix order of properties in propertiesSchema.json
|
|
30
|
+
- Update sampleProperties, unit and integration tests to have all new properties.
|
|
31
|
+
- Add all new calls to adapter.js and pronghorn.json
|
|
32
|
+
- Add suspend piece to older methods
|
|
5
33
|
|
|
6
34
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!7
|
|
7
35
|
|
|
@@ -9,7 +37,7 @@ See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!7
|
|
|
9
37
|
|
|
10
38
|
## 0.7.3 [07-10-2020]
|
|
11
39
|
|
|
12
|
-
|
|
40
|
+
- Update the adapter to the latest foundation
|
|
13
41
|
|
|
14
42
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!6
|
|
15
43
|
|
|
@@ -17,7 +45,7 @@ See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!6
|
|
|
17
45
|
|
|
18
46
|
## 0.7.2 [01-14-2020]
|
|
19
47
|
|
|
20
|
-
|
|
48
|
+
- Update the adapter to the latest foundation
|
|
21
49
|
|
|
22
50
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!5
|
|
23
51
|
|
|
@@ -25,7 +53,7 @@ See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!5
|
|
|
25
53
|
|
|
26
54
|
## 0.7.1 [11-19-2019]
|
|
27
55
|
|
|
28
|
-
|
|
56
|
+
- Update the healthcheck url to one that has been used in the lab
|
|
29
57
|
|
|
30
58
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!4
|
|
31
59
|
|
|
@@ -33,7 +61,18 @@ See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!4
|
|
|
33
61
|
|
|
34
62
|
## 0.7.0 [11-08-2019]
|
|
35
63
|
|
|
36
|
-
|
|
64
|
+
- Update the adapter to the latest adapter foundation.
|
|
65
|
+
- Updating to adapter-utils 4.24.3 (automatic)
|
|
66
|
+
- Add sample token schemas (manual)
|
|
67
|
+
- Adding placement property to getToken response schema (manual - before encrypt)
|
|
68
|
+
- Adding sso default into action.json for getToken (manual - before response object)
|
|
69
|
+
- Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
|
|
70
|
+
- Update sample properties to include new properties (manual)
|
|
71
|
+
- Update integration test for raw mockdata (automatic)
|
|
72
|
+
- Update test properties (manual)
|
|
73
|
+
- Changes to artifactize (automatic)
|
|
74
|
+
- Update type in sampleProperties so it is correct for the adapter (manual)
|
|
75
|
+
- Update the readme (automatic)
|
|
37
76
|
|
|
38
77
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!3
|
|
39
78
|
|
|
@@ -41,41 +80,22 @@ See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!3
|
|
|
41
80
|
|
|
42
81
|
## 0.6.0 [09-16-2019]
|
|
43
82
|
|
|
44
|
-
|
|
83
|
+
- Update the adapter to the latest adapter foundation
|
|
45
84
|
|
|
46
85
|
See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!2
|
|
47
86
|
|
|
48
87
|
---
|
|
49
|
-
## 0.5.0 [07-30-2019]
|
|
50
|
-
* migrate, categorize and artifactize
|
|
88
|
+
## 0.5.0 [07-30-2019] & 0.4.0 [07-18-2019] & 0.3.0 [07-16-2019] & 0.2.0 [07-16-2019]
|
|
51
89
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## 0.4.0 [07-18-2019]
|
|
57
|
-
* migrate, categorize and artifactize
|
|
58
|
-
|
|
59
|
-
See merge request itentialopensource/adapters/adapter-salesforce!1
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## 0.3.0 [07-16-2019]
|
|
64
|
-
* migrate, categorize and artifactize
|
|
65
|
-
|
|
66
|
-
See merge request itentialopensource/adapters/adapter-salesforce!1
|
|
67
|
-
|
|
68
|
-
---
|
|
69
|
-
|
|
70
|
-
## 0.2.0 [07-16-2019]
|
|
71
|
-
* migrate, categorize and artifactize
|
|
90
|
+
- Updates to the adapter foundation
|
|
72
91
|
|
|
73
92
|
See merge request itentialopensource/adapters/adapter-salesforce!1
|
|
74
93
|
|
|
75
94
|
---
|
|
76
95
|
|
|
77
96
|
## 0.1.1 [05-03-2019]
|
|
78
|
-
|
|
97
|
+
|
|
98
|
+
- Initial Commit
|
|
79
99
|
|
|
80
100
|
See commit e3e0165
|
|
81
101
|
|
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
|
|
|
8
8
|
|
|
9
9
|
Examples of behavior that contributes to creating a positive environment include:
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
- Using welcoming and inclusive language
|
|
12
|
+
- Being respectful of differing viewpoints and experiences
|
|
13
|
+
- Gracefully accepting constructive criticism
|
|
14
|
+
- Focusing on what is best for the community
|
|
15
|
+
- Showing empathy towards other community members
|
|
16
16
|
|
|
17
17
|
Examples of unacceptable behavior by participants include:
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
19
|
+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
|
|
20
|
+
- Trolling, insulting/derogatory comments, and personal or political attacks
|
|
21
|
+
- Public or private harassment
|
|
22
|
+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
|
|
23
|
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
|
24
24
|
|
|
25
25
|
## Our Responsibilities
|
|
26
26
|
|
|
@@ -34,15 +34,10 @@ This Code of Conduct applies both within project spaces and in public spaces whe
|
|
|
34
34
|
|
|
35
35
|
## Enforcement
|
|
36
36
|
|
|
37
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
|
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
|
38
38
|
|
|
39
39
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
|
40
40
|
|
|
41
41
|
## Attribution
|
|
42
42
|
|
|
43
|
-
This Code of Conduct is adapted from the
|
|
44
|
-
|
|
45
|
-
[homepage]: http://contributor-covenant.org
|
|
46
|
-
[version]: http://contributor-covenant.org/version/1/4/
|
|
47
|
-
|
|
48
|
-
_return to [README](../README.md)_
|
|
43
|
+
This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>
|