@itentialopensource/adapter-sharepoint 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 (71) hide show
  1. package/.eslintignore +6 -0
  2. package/.eslintrc.js +18 -0
  3. package/.gitlab/.gitkeep +0 -0
  4. package/.gitlab/issue_templates/.gitkeep +0 -0
  5. package/.gitlab/issue_templates/Default.md +17 -0
  6. package/.gitlab/issue_templates/bugReportTemplate.md +76 -0
  7. package/.gitlab/issue_templates/featureRequestTemplate.md +14 -0
  8. package/.jshintrc +0 -0
  9. package/AUTH.md +39 -0
  10. package/BROKER.md +199 -0
  11. package/CALLS.md +242 -0
  12. package/CHANGELOG.md +9 -0
  13. package/CODE_OF_CONDUCT.md +43 -0
  14. package/CONTRIBUTING.md +172 -0
  15. package/ENHANCE.md +69 -0
  16. package/LICENSE +201 -0
  17. package/PROPERTIES.md +641 -0
  18. package/README.md +337 -0
  19. package/SUMMARY.md +9 -0
  20. package/SYSTEMINFO.md +11 -0
  21. package/TROUBLESHOOT.md +47 -0
  22. package/adapter.js +1867 -0
  23. package/adapterBase.js +1787 -0
  24. package/entities/.generic/action.json +214 -0
  25. package/entities/.generic/schema.json +28 -0
  26. package/entities/.system/action.json +50 -0
  27. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  28. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  29. package/entities/.system/schema.json +19 -0
  30. package/entities/.system/schemaTokenReq.json +86 -0
  31. package/entities/.system/schemaTokenResp.json +53 -0
  32. package/entities/Files/action.json +67 -0
  33. package/entities/Files/schema.json +21 -0
  34. package/entities/Folders/action.json +106 -0
  35. package/entities/Folders/schema.json +23 -0
  36. package/entities/Lists/action.json +86 -0
  37. package/entities/Lists/schema.json +22 -0
  38. package/error.json +190 -0
  39. package/package.json +85 -0
  40. package/pronghorn.json +1153 -0
  41. package/propertiesDecorators.json +14 -0
  42. package/propertiesSchema.json +1248 -0
  43. package/refs?service=git-upload-pack +0 -0
  44. package/report/Sharepoint.postman_collection.json-OpenApi3Json.json +619 -0
  45. package/report/adapterInfo.json +10 -0
  46. package/report/creationReport.json +300 -0
  47. package/sampleProperties.json +195 -0
  48. package/test/integration/adapterTestBasicGet.js +83 -0
  49. package/test/integration/adapterTestConnectivity.js +93 -0
  50. package/test/integration/adapterTestIntegration.js +681 -0
  51. package/test/unit/adapterBaseTestUnit.js +949 -0
  52. package/test/unit/adapterTestUnit.js +1710 -0
  53. package/utils/adapterInfo.js +206 -0
  54. package/utils/addAuth.js +94 -0
  55. package/utils/artifactize.js +146 -0
  56. package/utils/basicGet.js +50 -0
  57. package/utils/checkMigrate.js +63 -0
  58. package/utils/entitiesToDB.js +178 -0
  59. package/utils/findPath.js +74 -0
  60. package/utils/methodDocumentor.js +225 -0
  61. package/utils/modify.js +154 -0
  62. package/utils/packModificationScript.js +35 -0
  63. package/utils/patches2bundledDeps.js +90 -0
  64. package/utils/pre-commit.sh +32 -0
  65. package/utils/removeHooks.js +20 -0
  66. package/utils/setup.js +33 -0
  67. package/utils/tbScript.js +246 -0
  68. package/utils/tbUtils.js +490 -0
  69. package/utils/testRunner.js +298 -0
  70. package/utils/troubleshootingAdapter.js +195 -0
  71. package/workflows/README.md +3 -0
package/adapter.js ADDED
@@ -0,0 +1,1867 @@
1
+ /* @copyright Itential, LLC 2019 (pre-modifications) */
2
+
3
+ /* eslint import/no-dynamic-require: warn */
4
+ /* eslint object-curly-newline: warn */
5
+
6
+ // Set globals
7
+ /* global log */
8
+
9
+ /* Required libraries. */
10
+ const path = require('path');
11
+
12
+ /* Fetch in the other needed components for the this Adaptor */
13
+ const AdapterBaseCl = require(path.join(__dirname, 'adapterBase.js'));
14
+
15
+ /**
16
+ * This is the adapter/interface into Sharepoint
17
+ */
18
+
19
+ /* GENERAL ADAPTER FUNCTIONS */
20
+ class Sharepoint extends AdapterBaseCl {
21
+ /**
22
+ * Sharepoint Adapter
23
+ * @constructor
24
+ */
25
+ /* Working on changing the way we do Emit methods due to size and time constrainsts
26
+ constructor(prongid, properties) {
27
+ // Instantiate the AdapterBase super class
28
+ super(prongid, properties);
29
+
30
+ const restFunctionNames = this.iapGetAdapterWorkflowFunctions();
31
+
32
+ // Dynamically bind emit functions
33
+ for (let i = 0; i < restFunctionNames.length; i += 1) {
34
+ // Bind function to have name fnNameEmit for fnName
35
+ const version = restFunctionNames[i].match(/__v[0-9]+/);
36
+ const baseFnName = restFunctionNames[i].replace(/__v[0-9]+/, '');
37
+ const fnNameEmit = version ? `${baseFnName}Emit${version}` : `${baseFnName}Emit`;
38
+ this[fnNameEmit] = function (...args) {
39
+ // extract the callback
40
+ const callback = args[args.length - 1];
41
+ // slice the callback from args so we can insert our own
42
+ const functionArgs = args.slice(0, args.length - 1);
43
+ // create a random name for the listener
44
+ const eventName = `${restFunctionNames[i]}:${Math.random().toString(36)}`;
45
+ // tell the calling class to start listening
46
+ callback({ event: eventName, status: 'received' });
47
+ // store parent for use of this context later
48
+ const parent = this;
49
+ // store emission function
50
+ const func = function (val, err) {
51
+ parent.removeListener(eventName, func);
52
+ parent.emit(eventName, val, err);
53
+ };
54
+ // Use apply to call the function in a specific context
55
+ this[restFunctionNames[i]].apply(this, functionArgs.concat([func])); // eslint-disable-line prefer-spread
56
+ };
57
+ }
58
+
59
+ // Uncomment if you have things to add to the constructor like using your own properties.
60
+ // Otherwise the constructor in the adapterBase will be used.
61
+ // Capture my own properties - they need to be defined in propertiesSchema.json
62
+ // if (this.allProps && this.allProps.myownproperty) {
63
+ // mypropvariable = this.allProps.myownproperty;
64
+ // }
65
+ }
66
+ */
67
+
68
+ /**
69
+ * @callback healthCallback
70
+ * @param {Object} reqObj - the request to send into the healthcheck
71
+ * @param {Callback} callback - The results of the call
72
+ */
73
+ healthCheck(reqObj, callback) {
74
+ // you can modify what is passed into the healthcheck by changing things in the newReq
75
+ let newReq = null;
76
+ if (reqObj) {
77
+ newReq = Object.assign(...reqObj);
78
+ }
79
+ super.healthCheck(newReq, callback);
80
+ }
81
+
82
+ /**
83
+ * @iapGetAdapterWorkflowFunctions
84
+ */
85
+ iapGetAdapterWorkflowFunctions(inIgnore) {
86
+ let myIgnore = [
87
+ 'healthCheck',
88
+ 'iapGetAdapterWorkflowFunctions',
89
+ 'iapHasAdapterEntity',
90
+ 'iapVerifyAdapterCapability',
91
+ 'iapUpdateAdapterEntityCache',
92
+ 'hasEntities'
93
+ ];
94
+ if (!inIgnore && Array.isArray(inIgnore)) {
95
+ myIgnore = inIgnore;
96
+ } else if (!inIgnore && typeof inIgnore === 'string') {
97
+ myIgnore = [inIgnore];
98
+ }
99
+
100
+ // The generic adapter functions should already be ignored (e.g. healthCheck)
101
+ // you can add specific methods that you do not want to be workflow functions to ignore like below
102
+ // myIgnore.push('myMethodNotInWorkflow');
103
+
104
+ return super.iapGetAdapterWorkflowFunctions(myIgnore);
105
+ }
106
+
107
+ /**
108
+ * iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
109
+ * allows customers to make changes to adapter configuration without having to be on the
110
+ * file system.
111
+ *
112
+ * @function iapUpdateAdapterConfiguration
113
+ * @param {string} configFile - the name of the file being updated (required)
114
+ * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
115
+ * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
116
+ * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
117
+ * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
118
+ * @param {Callback} callback - The results of the call
119
+ */
120
+ iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
121
+ const meth = 'adapter-iapUpdateAdapterConfiguration';
122
+ const origin = `${this.id}-${meth}`;
123
+ log.trace(origin);
124
+
125
+ super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback);
126
+ }
127
+
128
+ /**
129
+ * See if the API path provided is found in this adapter
130
+ *
131
+ * @function iapFindAdapterPath
132
+ * @param {string} apiPath - the api path to check on
133
+ * @param {Callback} callback - The results of the call
134
+ */
135
+ iapFindAdapterPath(apiPath, callback) {
136
+ const meth = 'adapter-iapFindAdapterPath';
137
+ const origin = `${this.id}-${meth}`;
138
+ log.trace(origin);
139
+
140
+ super.iapFindAdapterPath(apiPath, callback);
141
+ }
142
+
143
+ /**
144
+ * @summary Suspends adapter
145
+ *
146
+ * @function iapSuspendAdapter
147
+ * @param {Callback} callback - callback function
148
+ */
149
+ iapSuspendAdapter(mode, callback) {
150
+ const meth = 'adapter-iapSuspendAdapter';
151
+ const origin = `${this.id}-${meth}`;
152
+ log.trace(origin);
153
+
154
+ try {
155
+ return super.iapSuspendAdapter(mode, callback);
156
+ } catch (error) {
157
+ log.error(`${origin}: ${error}`);
158
+ return callback(null, error);
159
+ }
160
+ }
161
+
162
+ /**
163
+ * @summary Unsuspends adapter
164
+ *
165
+ * @function iapUnsuspendAdapter
166
+ * @param {Callback} callback - callback function
167
+ */
168
+ iapUnsuspendAdapter(callback) {
169
+ const meth = 'adapter-iapUnsuspendAdapter';
170
+ const origin = `${this.id}-${meth}`;
171
+ log.trace(origin);
172
+
173
+ try {
174
+ return super.iapUnsuspendAdapter(callback);
175
+ } catch (error) {
176
+ log.error(`${origin}: ${error}`);
177
+ return callback(null, error);
178
+ }
179
+ }
180
+
181
+ /**
182
+ * @summary Get the Adaoter Queue
183
+ *
184
+ * @function iapGetAdapterQueue
185
+ * @param {Callback} callback - callback function
186
+ */
187
+ iapGetAdapterQueue(callback) {
188
+ const meth = 'adapter-iapGetAdapterQueue';
189
+ const origin = `${this.id}-${meth}`;
190
+ log.trace(origin);
191
+
192
+ return super.iapGetAdapterQueue(callback);
193
+ }
194
+
195
+ /**
196
+ * @summary Runs troubleshoot scripts for adapter
197
+ *
198
+ * @function iapTroubleshootAdapter
199
+ * @param {Object} props - the connection, healthcheck and authentication properties
200
+ *
201
+ * @param {boolean} persistFlag - whether the adapter properties should be updated
202
+ * @param {Callback} callback - The results of the call
203
+ */
204
+ iapTroubleshootAdapter(props, persistFlag, callback) {
205
+ const meth = 'adapter-iapTroubleshootAdapter';
206
+ const origin = `${this.id}-${meth}`;
207
+ log.trace(origin);
208
+
209
+ try {
210
+ return super.iapTroubleshootAdapter(props, persistFlag, this, callback);
211
+ } catch (error) {
212
+ log.error(`${origin}: ${error}`);
213
+ return callback(null, error);
214
+ }
215
+ }
216
+
217
+ /**
218
+ * @summary runs healthcheck script for adapter
219
+ *
220
+ * @function iapRunAdapterHealthcheck
221
+ * @param {Adapter} adapter - adapter instance to troubleshoot
222
+ * @param {Callback} callback - callback function
223
+ */
224
+ iapRunAdapterHealthcheck(callback) {
225
+ const meth = 'adapter-iapRunAdapterHealthcheck';
226
+ const origin = `${this.id}-${meth}`;
227
+ log.trace(origin);
228
+
229
+ try {
230
+ return super.iapRunAdapterHealthcheck(this, callback);
231
+ } catch (error) {
232
+ log.error(`${origin}: ${error}`);
233
+ return callback(null, error);
234
+ }
235
+ }
236
+
237
+ /**
238
+ * @summary runs connectivity check script for adapter
239
+ *
240
+ * @function iapRunAdapterConnectivity
241
+ * @param {Callback} callback - callback function
242
+ */
243
+ iapRunAdapterConnectivity(callback) {
244
+ const meth = 'adapter-iapRunAdapterConnectivity';
245
+ const origin = `${this.id}-${meth}`;
246
+ log.trace(origin);
247
+
248
+ try {
249
+ return super.iapRunAdapterConnectivity(callback);
250
+ } catch (error) {
251
+ log.error(`${origin}: ${error}`);
252
+ return callback(null, error);
253
+ }
254
+ }
255
+
256
+ /**
257
+ * @summary runs basicGet script for adapter
258
+ *
259
+ * @function iapRunAdapterBasicGet
260
+ * @param {Callback} callback - callback function
261
+ */
262
+ iapRunAdapterBasicGet(callback) {
263
+ const meth = 'adapter-iapRunAdapterBasicGet';
264
+ const origin = `${this.id}-${meth}`;
265
+ log.trace(origin);
266
+
267
+ try {
268
+ return super.iapRunAdapterBasicGet(callback);
269
+ } catch (error) {
270
+ log.error(`${origin}: ${error}`);
271
+ return callback(null, error);
272
+ }
273
+ }
274
+
275
+ /**
276
+ * @summary moves entites into Mongo DB
277
+ *
278
+ * @function iapMoveAdapterEntitiesToDB
279
+ * @param {getCallback} callback - a callback function to return the result (Generics)
280
+ * or the error
281
+ */
282
+ iapMoveAdapterEntitiesToDB(callback) {
283
+ const meth = 'adapter-iapMoveAdapterEntitiesToDB';
284
+ const origin = `${this.id}-${meth}`;
285
+ log.trace(origin);
286
+
287
+ try {
288
+ return super.iapMoveAdapterEntitiesToDB(callback);
289
+ } catch (err) {
290
+ log.error(`${origin}: ${err}`);
291
+ return callback(null, err);
292
+ }
293
+ }
294
+
295
+ /* BROKER CALLS */
296
+ /**
297
+ * @summary Determines if this adapter supports the specific entity
298
+ *
299
+ * @function iapHasAdapterEntity
300
+ * @param {String} entityType - the entity type to check for
301
+ * @param {String/Array} entityId - the specific entity we are looking for
302
+ *
303
+ * @param {Callback} callback - An array of whether the adapter can has the
304
+ * desired capability or an error
305
+ */
306
+ iapHasAdapterEntity(entityType, entityId, callback) {
307
+ const origin = `${this.id}-adapter-iapHasAdapterEntity`;
308
+ log.trace(origin);
309
+
310
+ // Make the call -
311
+ // iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
312
+ return this.iapVerifyAdapterCapability(entityType, null, entityId, callback);
313
+ }
314
+
315
+ /**
316
+ * @summary Provides a way for the adapter to tell north bound integrations
317
+ * whether the adapter supports type, action and specific entity
318
+ *
319
+ * @function iapVerifyAdapterCapability
320
+ * @param {String} entityType - the entity type to check for
321
+ * @param {String} actionType - the action type to check for
322
+ * @param {String/Array} entityId - the specific entity we are looking for
323
+ *
324
+ * @param {Callback} callback - An array of whether the adapter can has the
325
+ * desired capability or an error
326
+ */
327
+ iapVerifyAdapterCapability(entityType, actionType, entityId, callback) {
328
+ const meth = 'adapterBase-iapVerifyAdapterCapability';
329
+ const origin = `${this.id}-${meth}`;
330
+ log.trace(origin);
331
+
332
+ // if caching
333
+ if (this.caching) {
334
+ // Make the call - iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
335
+ return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (results, error) => {
336
+ if (error) {
337
+ return callback(null, error);
338
+ }
339
+
340
+ // if the cache needs to be updated, update and try again
341
+ if (results && results[0] === 'needupdate') {
342
+ switch (entityType) {
343
+ case 'template_entity': {
344
+ // if the cache is invalid, update the cache
345
+ return this.getEntities(null, null, null, null, (data, err) => {
346
+ if (err) {
347
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
348
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
349
+ return callback(null, errorObj);
350
+ }
351
+
352
+ // need to check the cache again since it has been updated
353
+ return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (vcapable, verror) => {
354
+ if (verror) {
355
+ return callback(null, verror);
356
+ }
357
+
358
+ return this.capabilityResults(vcapable, callback);
359
+ });
360
+ });
361
+ }
362
+ default: {
363
+ // unsupported entity type
364
+ const result = [false];
365
+
366
+ // put false in array for all entities
367
+ if (Array.isArray(entityId)) {
368
+ for (let e = 1; e < entityId.length; e += 1) {
369
+ result.push(false);
370
+ }
371
+ }
372
+
373
+ return callback(result);
374
+ }
375
+ }
376
+ }
377
+
378
+ // return the results
379
+ return this.capabilityResults(results, callback);
380
+ });
381
+ }
382
+
383
+ // if no entity id
384
+ if (!entityId) {
385
+ // need to check the cache again since it has been updated
386
+ return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
387
+ if (verror) {
388
+ return callback(null, verror);
389
+ }
390
+
391
+ return this.capabilityResults(vcapable, callback);
392
+ });
393
+ }
394
+
395
+ // if not caching
396
+ switch (entityType) {
397
+ case 'template_entity': {
398
+ // need to get the entities to check
399
+ return this.getEntities(null, null, null, null, (data, err) => {
400
+ if (err) {
401
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
402
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
403
+ return callback(null, errorObj);
404
+ }
405
+
406
+ // need to check the cache again since it has been updated
407
+ return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
408
+ if (verror) {
409
+ return callback(null, verror);
410
+ }
411
+
412
+ // is the entity in the list?
413
+ const isEntity = this.entityInList(entityId, data.response, callback);
414
+ const res = [];
415
+
416
+ // not found
417
+ for (let i = 0; i < isEntity.length; i += 1) {
418
+ if (vcapable) {
419
+ res.push(isEntity[i]);
420
+ } else {
421
+ res.push(false);
422
+ }
423
+ }
424
+
425
+ return callback(res);
426
+ });
427
+ });
428
+ }
429
+ default: {
430
+ // unsupported entity type
431
+ const result = [false];
432
+
433
+ // put false in array for all entities
434
+ if (Array.isArray(entityId)) {
435
+ for (let e = 1; e < entityId.length; e += 1) {
436
+ result.push(false);
437
+ }
438
+ }
439
+
440
+ return callback(result);
441
+ }
442
+ }
443
+ }
444
+
445
+ /**
446
+ * @summary Updates the cache for all entities by call the get All entity method
447
+ *
448
+ * @function iapUpdateAdapterEntityCache
449
+ *
450
+ */
451
+ iapUpdateAdapterEntityCache() {
452
+ const origin = `${this.id}-adapter-iapUpdateAdapterEntityCache`;
453
+ log.trace(origin);
454
+
455
+ if (this.caching) {
456
+ // if the cache is invalid, update the cache
457
+ this.getEntities(null, null, null, null, (data, err) => {
458
+ if (err) {
459
+ log.trace(`${origin}: Could not load template_entity into cache - ${err}`);
460
+ }
461
+ });
462
+ }
463
+ }
464
+
465
+ /**
466
+ * @summary Determines if this adapter supports any in a list of entities
467
+ *
468
+ * @function hasEntities
469
+ * @param {String} entityType - the entity type to check for
470
+ * @param {Array} entityList - the list of entities we are looking for
471
+ *
472
+ * @param {Callback} callback - A map where the entity is the key and the
473
+ * value is true or false
474
+ */
475
+ hasEntities(entityType, entityList, callback) {
476
+ const meth = 'adapter-hasEntities';
477
+ const origin = `${this.id}-${meth}`;
478
+ log.trace(origin);
479
+
480
+ try {
481
+ return super.hasEntities(entityType, entityList, callback);
482
+ } catch (err) {
483
+ log.error(`${origin}: ${err}`);
484
+ return callback(null, err);
485
+ }
486
+ }
487
+
488
+ /**
489
+ * @summary Get Appliance that match the deviceName
490
+ *
491
+ * @function getDevice
492
+ * @param {String} deviceName - the deviceName to find (required)
493
+ *
494
+ * @param {getCallback} callback - a callback function to return the result
495
+ * (appliance) or the error
496
+ */
497
+ getDevice(deviceName, callback) {
498
+ const meth = 'adapter-getDevice';
499
+ const origin = `${this.id}-${meth}`;
500
+ log.trace(origin);
501
+
502
+ try {
503
+ return super.getDevice(deviceName, callback);
504
+ } catch (err) {
505
+ log.error(`${origin}: ${err}`);
506
+ return callback(null, err);
507
+ }
508
+ }
509
+
510
+ /**
511
+ * @summary Get Appliances that match the filter
512
+ *
513
+ * @function getDevicesFiltered
514
+ * @param {Object} options - the data to use to filter the appliances (optional)
515
+ *
516
+ * @param {getCallback} callback - a callback function to return the result
517
+ * (appliances) or the error
518
+ */
519
+ getDevicesFiltered(options, callback) {
520
+ const meth = 'adapter-getDevicesFiltered';
521
+ const origin = `${this.id}-${meth}`;
522
+ log.trace(origin);
523
+
524
+ try {
525
+ return super.getDevicesFiltered(options, callback);
526
+ } catch (err) {
527
+ log.error(`${origin}: ${err}`);
528
+ return callback(null, err);
529
+ }
530
+ }
531
+
532
+ /**
533
+ * @summary Gets the status for the provided appliance
534
+ *
535
+ * @function isAlive
536
+ * @param {String} deviceName - the deviceName of the appliance. (required)
537
+ *
538
+ * @param {configCallback} callback - callback function to return the result
539
+ * (appliance isAlive) or the error
540
+ */
541
+ isAlive(deviceName, callback) {
542
+ const meth = 'adapter-isAlive';
543
+ const origin = `${this.id}-${meth}`;
544
+ log.trace(origin);
545
+
546
+ try {
547
+ return super.isAlive(deviceName, callback);
548
+ } catch (err) {
549
+ log.error(`${origin}: ${err}`);
550
+ return callback(null, err);
551
+ }
552
+ }
553
+
554
+ /**
555
+ * @summary Gets a config for the provided Appliance
556
+ *
557
+ * @function getConfig
558
+ * @param {String} deviceName - the deviceName of the appliance. (required)
559
+ * @param {String} format - the desired format of the config. (optional)
560
+ *
561
+ * @param {configCallback} callback - callback function to return the result
562
+ * (appliance config) or the error
563
+ */
564
+ getConfig(deviceName, format, callback) {
565
+ const meth = 'adapter-getConfig';
566
+ const origin = `${this.id}-${meth}`;
567
+ log.trace(origin);
568
+
569
+ try {
570
+ return super.getConfig(deviceName, format, callback);
571
+ } catch (err) {
572
+ log.error(`${origin}: ${err}`);
573
+ return callback(null, err);
574
+ }
575
+ }
576
+
577
+ /**
578
+ * @summary Gets the device count from the system
579
+ *
580
+ * @function iapGetDeviceCount
581
+ *
582
+ * @param {getCallback} callback - callback function to return the result
583
+ * (count) or the error
584
+ */
585
+ iapGetDeviceCount(callback) {
586
+ const meth = 'adapter-iapGetDeviceCount';
587
+ const origin = `${this.id}-${meth}`;
588
+ log.trace(origin);
589
+
590
+ try {
591
+ return super.iapGetDeviceCount(callback);
592
+ } catch (err) {
593
+ log.error(`${origin}: ${err}`);
594
+ return callback(null, err);
595
+ }
596
+ }
597
+
598
+ /* GENERIC ADAPTER REQUEST - allows extension of adapter without new calls being added */
599
+ /**
600
+ * Makes the requested generic call
601
+ *
602
+ * @function genericAdapterRequest
603
+ * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
604
+ * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
605
+ * @param {Object} queryData - the parameters to be put on the url (optional).
606
+ * Can be a stringified Object.
607
+ * @param {Object} requestBody - the body to add to the request (optional).
608
+ * Can be a stringified Object.
609
+ * @param {Object} addlHeaders - additional headers to be put on the call (optional).
610
+ * Can be a stringified Object.
611
+ * @param {getCallback} callback - a callback function to return the result (Generics)
612
+ * or the error
613
+ */
614
+ genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
615
+ const meth = 'adapter-genericAdapterRequest';
616
+ const origin = `${this.id}-${meth}`;
617
+ log.trace(origin);
618
+
619
+ if (this.suspended && this.suspendMode === 'error') {
620
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
621
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
622
+ return callback(null, errorObj);
623
+ }
624
+
625
+ /* HERE IS WHERE YOU VALIDATE DATA */
626
+ if (uriPath === undefined || uriPath === null || uriPath === '') {
627
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
628
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
629
+ return callback(null, errorObj);
630
+ }
631
+ if (restMethod === undefined || restMethod === null || restMethod === '') {
632
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
633
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
634
+ return callback(null, errorObj);
635
+ }
636
+
637
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
638
+ // remove any leading / and split the uripath into path variables
639
+ let myPath = uriPath;
640
+ while (myPath.indexOf('/') === 0) {
641
+ myPath = myPath.substring(1);
642
+ }
643
+ const pathVars = myPath.split('/');
644
+ const queryParamsAvailable = queryData;
645
+ const queryParams = {};
646
+ const bodyVars = requestBody;
647
+
648
+ // loop in template. long callback arg name to avoid identifier conflicts
649
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
650
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
651
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
652
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
653
+ }
654
+ });
655
+
656
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
657
+ const reqObj = {
658
+ payload: bodyVars,
659
+ uriPathVars: pathVars,
660
+ uriQuery: queryParams,
661
+ uriOptions: {}
662
+ };
663
+ // add headers if provided
664
+ if (addlHeaders) {
665
+ reqObj.addlHeaders = addlHeaders;
666
+ }
667
+
668
+ // determine the call and return flag
669
+ let action = 'getGenerics';
670
+ let returnF = true;
671
+ if (restMethod.toUpperCase() === 'POST') {
672
+ action = 'createGeneric';
673
+ } else if (restMethod.toUpperCase() === 'PUT') {
674
+ action = 'updateGeneric';
675
+ } else if (restMethod.toUpperCase() === 'PATCH') {
676
+ action = 'patchGeneric';
677
+ } else if (restMethod.toUpperCase() === 'DELETE') {
678
+ action = 'deleteGeneric';
679
+ returnF = false;
680
+ }
681
+
682
+ try {
683
+ // Make the call -
684
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
685
+ return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
686
+ // if we received an error or their is no response on the results
687
+ // return an error
688
+ if (irReturnError) {
689
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
690
+ return callback(null, irReturnError);
691
+ }
692
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
693
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequest'], null, null, null);
694
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
695
+ return callback(null, errorObj);
696
+ }
697
+
698
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
699
+ // return the response
700
+ return callback(irReturnData, null);
701
+ });
702
+ } catch (ex) {
703
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
704
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
705
+ return callback(null, errorObj);
706
+ }
707
+ }
708
+
709
+ /**
710
+ * Makes the requested generic call with no base path or version
711
+ *
712
+ * @function genericAdapterRequestNoBasePath
713
+ * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
714
+ * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
715
+ * @param {Object} queryData - the parameters to be put on the url (optional).
716
+ * Can be a stringified Object.
717
+ * @param {Object} requestBody - the body to add to the request (optional).
718
+ * Can be a stringified Object.
719
+ * @param {Object} addlHeaders - additional headers to be put on the call (optional).
720
+ * Can be a stringified Object.
721
+ * @param {getCallback} callback - a callback function to return the result (Generics)
722
+ * or the error
723
+ */
724
+ genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
725
+ const meth = 'adapter-genericAdapterRequestNoBasePath';
726
+ const origin = `${this.id}-${meth}`;
727
+ log.trace(origin);
728
+
729
+ if (this.suspended && this.suspendMode === 'error') {
730
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
731
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
732
+ return callback(null, errorObj);
733
+ }
734
+
735
+ /* HERE IS WHERE YOU VALIDATE DATA */
736
+ if (uriPath === undefined || uriPath === null || uriPath === '') {
737
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
738
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
739
+ return callback(null, errorObj);
740
+ }
741
+ if (restMethod === undefined || restMethod === null || restMethod === '') {
742
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
743
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
744
+ return callback(null, errorObj);
745
+ }
746
+
747
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
748
+ // remove any leading / and split the uripath into path variables
749
+ let myPath = uriPath;
750
+ while (myPath.indexOf('/') === 0) {
751
+ myPath = myPath.substring(1);
752
+ }
753
+ const pathVars = myPath.split('/');
754
+ const queryParamsAvailable = queryData;
755
+ const queryParams = {};
756
+ const bodyVars = requestBody;
757
+
758
+ // loop in template. long callback arg name to avoid identifier conflicts
759
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
760
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
761
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
762
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
763
+ }
764
+ });
765
+
766
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
767
+ const reqObj = {
768
+ payload: bodyVars,
769
+ uriPathVars: pathVars,
770
+ uriQuery: queryParams,
771
+ uriOptions: {}
772
+ };
773
+ // add headers if provided
774
+ if (addlHeaders) {
775
+ reqObj.addlHeaders = addlHeaders;
776
+ }
777
+
778
+ // determine the call and return flag
779
+ let action = 'getGenericsNoBase';
780
+ let returnF = true;
781
+ if (restMethod.toUpperCase() === 'POST') {
782
+ action = 'createGenericNoBase';
783
+ } else if (restMethod.toUpperCase() === 'PUT') {
784
+ action = 'updateGenericNoBase';
785
+ } else if (restMethod.toUpperCase() === 'PATCH') {
786
+ action = 'patchGenericNoBase';
787
+ } else if (restMethod.toUpperCase() === 'DELETE') {
788
+ action = 'deleteGenericNoBase';
789
+ returnF = false;
790
+ }
791
+
792
+ try {
793
+ // Make the call -
794
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
795
+ return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
796
+ // if we received an error or their is no response on the results
797
+ // return an error
798
+ if (irReturnError) {
799
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
800
+ return callback(null, irReturnError);
801
+ }
802
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
803
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequestNoBasePath'], null, null, null);
804
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
805
+ return callback(null, errorObj);
806
+ }
807
+
808
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
809
+ // return the response
810
+ return callback(irReturnData, null);
811
+ });
812
+ } catch (ex) {
813
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
814
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
815
+ return callback(null, errorObj);
816
+ }
817
+ }
818
+
819
+ /**
820
+ * @callback healthCallback
821
+ * @param {Object} result - the result of the get request (contains an id and a status)
822
+ */
823
+ /**
824
+ * @callback getCallback
825
+ * @param {Object} result - the result of the get request (entity/ies)
826
+ * @param {String} error - any error that occurred
827
+ */
828
+ /**
829
+ * @callback createCallback
830
+ * @param {Object} item - the newly created entity
831
+ * @param {String} error - any error that occurred
832
+ */
833
+ /**
834
+ * @callback updateCallback
835
+ * @param {String} status - the status of the update action
836
+ * @param {String} error - any error that occurred
837
+ */
838
+ /**
839
+ * @callback deleteCallback
840
+ * @param {String} status - the status of the delete action
841
+ * @param {String} error - any error that occurred
842
+ */
843
+
844
+ /**
845
+ * @function getListByTitle
846
+ * @pronghornType method
847
+ * @name getListByTitle
848
+ * @summary getListByTitle
849
+ *
850
+ * @param {string} title - title param
851
+ * @param {getCallback} callback - a callback function to return the result
852
+ * @return {object} results - An object containing the response of the action
853
+ *
854
+ * @route {POST} /getListByTitle
855
+ * @roles admin
856
+ * @task true
857
+ */
858
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
859
+ getListByTitle(title, callback) {
860
+ const meth = 'adapter-getListByTitle';
861
+ const origin = `${this.id}-${meth}`;
862
+ log.trace(origin);
863
+
864
+ if (this.suspended && this.suspendMode === 'error') {
865
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
866
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
867
+ return callback(null, errorObj);
868
+ }
869
+
870
+ /* HERE IS WHERE YOU VALIDATE DATA */
871
+ if (title === undefined || title === null || title === '') {
872
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['title'], null, null, null);
873
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
874
+ return callback(null, errorObj);
875
+ }
876
+
877
+ const pathStr = `GetByTitle('${title}')`;
878
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
879
+ const queryParamsAvailable = {};
880
+ const queryParams = {};
881
+ const pathVars = [pathStr];
882
+ const bodyVars = {};
883
+
884
+ // loop in template. long callback arg name to avoid identifier conflicts
885
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
886
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
887
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
888
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
889
+ }
890
+ });
891
+
892
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
893
+ // see adapter code documentation for more information on the request object's fields
894
+ const reqObj = {
895
+ payload: bodyVars,
896
+ uriPathVars: pathVars,
897
+ uriQuery: queryParams
898
+ };
899
+
900
+ try {
901
+ // Make the call -
902
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
903
+ return this.requestHandlerInst.identifyRequest('Lists', 'getListByTitle', reqObj, true, (irReturnData, irReturnError) => {
904
+ // if we received an error or their is no response on the results
905
+ // return an error
906
+ if (irReturnError) {
907
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
908
+ return callback(null, irReturnError);
909
+ }
910
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
911
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getListByTitle'], null, null, null);
912
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
913
+ return callback(null, errorObj);
914
+ }
915
+
916
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
917
+ // return the response
918
+ return callback(irReturnData, null);
919
+ });
920
+ } catch (ex) {
921
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
922
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
923
+ return callback(null, errorObj);
924
+ }
925
+ }
926
+
927
+ /**
928
+ * @function getGuid
929
+ * @pronghornType method
930
+ * @name getGuid
931
+ * @summary getListByGuid
932
+ *
933
+ * @param {string} guid - guid param
934
+ * @param {getCallback} callback - a callback function to return the result
935
+ * @return {object} results - An object containing the response of the action
936
+ *
937
+ * @route {POST} /getGuid
938
+ * @roles admin
939
+ * @task true
940
+ */
941
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
942
+ getGuid(guid, callback) {
943
+ const meth = 'adapter-getGuid';
944
+ const origin = `${this.id}-${meth}`;
945
+ log.trace(origin);
946
+
947
+ if (this.suspended && this.suspendMode === 'error') {
948
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
949
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
950
+ return callback(null, errorObj);
951
+ }
952
+
953
+ /* HERE IS WHERE YOU VALIDATE DATA */
954
+ if (guid === undefined || guid === null || guid === '') {
955
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['guid'], null, null, null);
956
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
957
+ return callback(null, errorObj);
958
+ }
959
+
960
+ const pathStr = `lists(guid'${guid}')`;
961
+
962
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
963
+ const queryParamsAvailable = {};
964
+ const queryParams = {};
965
+ const pathVars = [pathStr];
966
+ const bodyVars = {};
967
+
968
+ // loop in template. long callback arg name to avoid identifier conflicts
969
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
970
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
971
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
972
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
973
+ }
974
+ });
975
+
976
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
977
+ // see adapter code documentation for more information on the request object's fields
978
+ const reqObj = {
979
+ payload: bodyVars,
980
+ uriPathVars: pathVars,
981
+ uriQuery: queryParams
982
+ };
983
+
984
+ try {
985
+ // Make the call -
986
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
987
+ return this.requestHandlerInst.identifyRequest('Lists', 'getGuid', reqObj, true, (irReturnData, irReturnError) => {
988
+ // if we received an error or their is no response on the results
989
+ // return an error
990
+ if (irReturnError) {
991
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
992
+ return callback(null, irReturnError);
993
+ }
994
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
995
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getGuid'], null, null, null);
996
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
997
+ return callback(null, errorObj);
998
+ }
999
+
1000
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1001
+ // return the response
1002
+ return callback(irReturnData, null);
1003
+ });
1004
+ } catch (ex) {
1005
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1006
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1007
+ return callback(null, errorObj);
1008
+ }
1009
+ }
1010
+
1011
+ /**
1012
+ * @function updateList
1013
+ * @pronghornType method
1014
+ * @name updateList
1015
+ * @summary updateList
1016
+ *
1017
+ * @param {string} guid - guid param
1018
+ * @param {object} body - body param
1019
+ * @param {getCallback} callback - a callback function to return the result
1020
+ * @return {object} results - An object containing the response of the action
1021
+ *
1022
+ * @route {POST} /updateList
1023
+ * @roles admin
1024
+ * @task true
1025
+ */
1026
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1027
+ updateList(guid, body, callback) {
1028
+ const meth = 'adapter-updateList';
1029
+ const origin = `${this.id}-${meth}`;
1030
+ log.trace(origin);
1031
+
1032
+ if (this.suspended && this.suspendMode === 'error') {
1033
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1034
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1035
+ return callback(null, errorObj);
1036
+ }
1037
+
1038
+ /* HERE IS WHERE YOU VALIDATE DATA */
1039
+ if (guid === undefined || guid === null || guid === '') {
1040
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['guid'], null, null, null);
1041
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1042
+ return callback(null, errorObj);
1043
+ }
1044
+ if (body === undefined || body === null || body === '') {
1045
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
1046
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1047
+ return callback(null, errorObj);
1048
+ }
1049
+
1050
+ const pathStr = `lists(guid'${guid}')`;
1051
+
1052
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1053
+ const queryParamsAvailable = {};
1054
+ const queryParams = {};
1055
+ const pathVars = [pathStr];
1056
+ const bodyVars = body;
1057
+
1058
+ // loop in template. long callback arg name to avoid identifier conflicts
1059
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1060
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1061
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1062
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1063
+ }
1064
+ });
1065
+
1066
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1067
+ // see adapter code documentation for more information on the request object's fields
1068
+ const reqObj = {
1069
+ payload: bodyVars,
1070
+ uriPathVars: pathVars,
1071
+ uriQuery: queryParams
1072
+ };
1073
+
1074
+ try {
1075
+ // Make the call -
1076
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1077
+ return this.requestHandlerInst.identifyRequest('Lists', 'updateList', reqObj, true, (irReturnData, irReturnError) => {
1078
+ // if we received an error or their is no response on the results
1079
+ // return an error
1080
+ if (irReturnError) {
1081
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1082
+ return callback(null, irReturnError);
1083
+ }
1084
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1085
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['updateList'], null, null, null);
1086
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1087
+ return callback(null, errorObj);
1088
+ }
1089
+
1090
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1091
+ // return the response
1092
+ return callback(irReturnData, null);
1093
+ });
1094
+ } catch (ex) {
1095
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1096
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1097
+ return callback(null, errorObj);
1098
+ }
1099
+ }
1100
+
1101
+ /**
1102
+ * @function createList
1103
+ * @pronghornType method
1104
+ * @name createList
1105
+ * @summary createList
1106
+ *
1107
+ * @param {object} body - body param
1108
+ * @param {getCallback} callback - a callback function to return the result
1109
+ * @return {object} results - An object containing the response of the action
1110
+ *
1111
+ * @route {POST} /createList
1112
+ * @roles admin
1113
+ * @task true
1114
+ */
1115
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1116
+ createList(body, callback) {
1117
+ const meth = 'adapter-createList';
1118
+ const origin = `${this.id}-${meth}`;
1119
+ log.trace(origin);
1120
+
1121
+ if (this.suspended && this.suspendMode === 'error') {
1122
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1123
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1124
+ return callback(null, errorObj);
1125
+ }
1126
+
1127
+ /* HERE IS WHERE YOU VALIDATE DATA */
1128
+ if (body === undefined || body === null || body === '') {
1129
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
1130
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1131
+ return callback(null, errorObj);
1132
+ }
1133
+
1134
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1135
+ const queryParamsAvailable = {};
1136
+ const queryParams = {};
1137
+ const pathVars = [];
1138
+ const bodyVars = body;
1139
+
1140
+ // loop in template. long callback arg name to avoid identifier conflicts
1141
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1142
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1143
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1144
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1145
+ }
1146
+ });
1147
+
1148
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1149
+ // see adapter code documentation for more information on the request object's fields
1150
+ const reqObj = {
1151
+ payload: bodyVars,
1152
+ uriPathVars: pathVars,
1153
+ uriQuery: queryParams
1154
+ };
1155
+
1156
+ try {
1157
+ // Make the call -
1158
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1159
+ return this.requestHandlerInst.identifyRequest('Lists', 'createList', reqObj, true, (irReturnData, irReturnError) => {
1160
+ // if we received an error or their is no response on the results
1161
+ // return an error
1162
+ if (irReturnError) {
1163
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1164
+ return callback(null, irReturnError);
1165
+ }
1166
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1167
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['createList'], null, null, null);
1168
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1169
+ return callback(null, errorObj);
1170
+ }
1171
+
1172
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1173
+ // return the response
1174
+ return callback(irReturnData, null);
1175
+ });
1176
+ } catch (ex) {
1177
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1178
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1179
+ return callback(null, errorObj);
1180
+ }
1181
+ }
1182
+
1183
+ /**
1184
+ * @function getFolderByServerRelativeUrl
1185
+ * @pronghornType method
1186
+ * @name getFolderByServerRelativeUrl
1187
+ * @summary getFolderByServerRelativeUrl
1188
+ *
1189
+ * @param {string} relativeUrl - relativeUrl param
1190
+ * @param {getCallback} callback - a callback function to return the result
1191
+ * @return {object} results - An object containing the response of the action
1192
+ *
1193
+ * @route {POST} /getFolderByServerRelativeUrl
1194
+ * @roles admin
1195
+ * @task true
1196
+ */
1197
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1198
+ getFolderByServerRelativeUrl(relativeUrl, callback) {
1199
+ const meth = 'adapter-getFolderByServerRelativeUrl';
1200
+ const origin = `${this.id}-${meth}`;
1201
+ log.trace(origin);
1202
+
1203
+ if (this.suspended && this.suspendMode === 'error') {
1204
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1205
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1206
+ return callback(null, errorObj);
1207
+ }
1208
+
1209
+ /* HERE IS WHERE YOU VALIDATE DATA */
1210
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1211
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1212
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1213
+ return callback(null, errorObj);
1214
+ }
1215
+
1216
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1217
+
1218
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1219
+ const queryParamsAvailable = {};
1220
+ const queryParams = {};
1221
+ const pathVars = [pathStr];
1222
+ const bodyVars = {};
1223
+
1224
+ // loop in template. long callback arg name to avoid identifier conflicts
1225
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1226
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1227
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1228
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1229
+ }
1230
+ });
1231
+
1232
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1233
+ // see adapter code documentation for more information on the request object's fields
1234
+ const reqObj = {
1235
+ payload: bodyVars,
1236
+ uriPathVars: pathVars,
1237
+ uriQuery: queryParams
1238
+ };
1239
+
1240
+ try {
1241
+ // Make the call -
1242
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1243
+ return this.requestHandlerInst.identifyRequest('Folders', 'getFolderByServerRelativeUrl', reqObj, true, (irReturnData, irReturnError) => {
1244
+ // if we received an error or their is no response on the results
1245
+ // return an error
1246
+ if (irReturnError) {
1247
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1248
+ return callback(null, irReturnError);
1249
+ }
1250
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1251
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFolderByServerRelativeUrl'], null, null, null);
1252
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1253
+ return callback(null, errorObj);
1254
+ }
1255
+
1256
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1257
+ // return the response
1258
+ return callback(irReturnData, null);
1259
+ });
1260
+ } catch (ex) {
1261
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1262
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1263
+ return callback(null, errorObj);
1264
+ }
1265
+ }
1266
+
1267
+ /**
1268
+ * @function deleteFolder
1269
+ * @pronghornType method
1270
+ * @name deleteFolder
1271
+ * @summary deleteFolder
1272
+ *
1273
+ * @param {string} relativeUrl - relativeUrl param
1274
+ * @param {getCallback} callback - a callback function to return the result
1275
+ * @return {object} results - An object containing the response of the action
1276
+ *
1277
+ * @route {POST} /deleteFolder
1278
+ * @roles admin
1279
+ * @task true
1280
+ */
1281
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1282
+ deleteFolder(relativeUrl, callback) {
1283
+ const meth = 'adapter-deleteFolder';
1284
+ const origin = `${this.id}-${meth}`;
1285
+ log.trace(origin);
1286
+
1287
+ if (this.suspended && this.suspendMode === 'error') {
1288
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1289
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1290
+ return callback(null, errorObj);
1291
+ }
1292
+
1293
+ /* HERE IS WHERE YOU VALIDATE DATA */
1294
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1295
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1296
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1297
+ return callback(null, errorObj);
1298
+ }
1299
+
1300
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1301
+
1302
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1303
+ const queryParamsAvailable = {};
1304
+ const queryParams = {};
1305
+ const pathVars = [pathStr];
1306
+ const bodyVars = {};
1307
+
1308
+ // loop in template. long callback arg name to avoid identifier conflicts
1309
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1310
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1311
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1312
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1313
+ }
1314
+ });
1315
+
1316
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1317
+ // see adapter code documentation for more information on the request object's fields
1318
+ const reqObj = {
1319
+ payload: bodyVars,
1320
+ uriPathVars: pathVars,
1321
+ uriQuery: queryParams
1322
+ };
1323
+
1324
+ try {
1325
+ // Make the call -
1326
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1327
+ return this.requestHandlerInst.identifyRequest('Folders', 'deleteFolder', reqObj, true, (irReturnData, irReturnError) => {
1328
+ // if we received an error or their is no response on the results
1329
+ // return an error
1330
+ if (irReturnError) {
1331
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1332
+ return callback(null, irReturnError);
1333
+ }
1334
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1335
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['deleteFolder'], null, null, null);
1336
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1337
+ return callback(null, errorObj);
1338
+ }
1339
+
1340
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1341
+ // return the response
1342
+ return callback(irReturnData, null);
1343
+ });
1344
+ } catch (ex) {
1345
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1346
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1347
+ return callback(null, errorObj);
1348
+ }
1349
+ }
1350
+
1351
+ /**
1352
+ * @function createFolder
1353
+ * @pronghornType method
1354
+ * @name createFolder
1355
+ * @summary createFolder
1356
+ *
1357
+ * @param {object} body - body param
1358
+ * @param {getCallback} callback - a callback function to return the result
1359
+ * @return {object} results - An object containing the response of the action
1360
+ *
1361
+ * @route {POST} /createFolder
1362
+ * @roles admin
1363
+ * @task true
1364
+ */
1365
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1366
+ createFolder(body, callback) {
1367
+ const meth = 'adapter-createFolder';
1368
+ const origin = `${this.id}-${meth}`;
1369
+ log.trace(origin);
1370
+
1371
+ if (this.suspended && this.suspendMode === 'error') {
1372
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1373
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1374
+ return callback(null, errorObj);
1375
+ }
1376
+
1377
+ /* HERE IS WHERE YOU VALIDATE DATA */
1378
+ if (body === undefined || body === null || body === '') {
1379
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
1380
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1381
+ return callback(null, errorObj);
1382
+ }
1383
+
1384
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1385
+ const queryParamsAvailable = {};
1386
+ const queryParams = {};
1387
+ const pathVars = [];
1388
+ const bodyVars = body;
1389
+
1390
+ // loop in template. long callback arg name to avoid identifier conflicts
1391
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1392
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1393
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1394
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1395
+ }
1396
+ });
1397
+
1398
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1399
+ // see adapter code documentation for more information on the request object's fields
1400
+ const reqObj = {
1401
+ payload: bodyVars,
1402
+ uriPathVars: pathVars,
1403
+ uriQuery: queryParams
1404
+ };
1405
+
1406
+ try {
1407
+ // Make the call -
1408
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1409
+ return this.requestHandlerInst.identifyRequest('Folders', 'createFolder', reqObj, true, (irReturnData, irReturnError) => {
1410
+ // if we received an error or their is no response on the results
1411
+ // return an error
1412
+ if (irReturnError) {
1413
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1414
+ return callback(null, irReturnError);
1415
+ }
1416
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1417
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['createFolder'], null, null, null);
1418
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1419
+ return callback(null, errorObj);
1420
+ }
1421
+
1422
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1423
+ // return the response
1424
+ return callback(irReturnData, null);
1425
+ });
1426
+ } catch (ex) {
1427
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1428
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1429
+ return callback(null, errorObj);
1430
+ }
1431
+ }
1432
+
1433
+ /**
1434
+ * @function getFolderODataType
1435
+ * @pronghornType method
1436
+ * @name getFolderODataType
1437
+ * @summary getFolderODataType
1438
+ *
1439
+ * @param {string} relativeUrl - relativeUrl param
1440
+ * @param {getCallback} callback - a callback function to return the result
1441
+ * @return {object} results - An object containing the response of the action
1442
+ *
1443
+ * @route {POST} /getFolderODataType
1444
+ * @roles admin
1445
+ * @task true
1446
+ */
1447
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1448
+ getFolderODataType(relativeUrl, callback) {
1449
+ const meth = 'adapter-getFolderODataType';
1450
+ const origin = `${this.id}-${meth}`;
1451
+ log.trace(origin);
1452
+
1453
+ if (this.suspended && this.suspendMode === 'error') {
1454
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1455
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1456
+ return callback(null, errorObj);
1457
+ }
1458
+
1459
+ /* HERE IS WHERE YOU VALIDATE DATA */
1460
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1461
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1462
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1463
+ return callback(null, errorObj);
1464
+ }
1465
+
1466
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1467
+
1468
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1469
+ const queryParamsAvailable = {};
1470
+ const queryParams = {};
1471
+ const pathVars = [pathStr];
1472
+ const bodyVars = {};
1473
+
1474
+ // loop in template. long callback arg name to avoid identifier conflicts
1475
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1476
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1477
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1478
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1479
+ }
1480
+ });
1481
+
1482
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1483
+ // see adapter code documentation for more information on the request object's fields
1484
+ const reqObj = {
1485
+ payload: bodyVars,
1486
+ uriPathVars: pathVars,
1487
+ uriQuery: queryParams
1488
+ };
1489
+
1490
+ try {
1491
+ // Make the call -
1492
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1493
+ return this.requestHandlerInst.identifyRequest('Folders', 'getFolderODataType', reqObj, true, (irReturnData, irReturnError) => {
1494
+ // if we received an error or their is no response on the results
1495
+ // return an error
1496
+ if (irReturnError) {
1497
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1498
+ return callback(null, irReturnError);
1499
+ }
1500
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1501
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFolderODataType'], null, null, null);
1502
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1503
+ return callback(null, errorObj);
1504
+ }
1505
+
1506
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1507
+ // return the response
1508
+ return callback(irReturnData, null);
1509
+ });
1510
+ } catch (ex) {
1511
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1512
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1513
+ return callback(null, errorObj);
1514
+ }
1515
+ }
1516
+
1517
+ /**
1518
+ * @function renameFolder
1519
+ * @pronghornType method
1520
+ * @name renameFolder
1521
+ * @summary renameFolder
1522
+ *
1523
+ * @param {string} relativeUrl - relativeUrl param
1524
+ * @param {object} body - body param
1525
+ * @param {getCallback} callback - a callback function to return the result
1526
+ * @return {object} results - An object containing the response of the action
1527
+ *
1528
+ * @route {POST} /renameFolder
1529
+ * @roles admin
1530
+ * @task true
1531
+ */
1532
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1533
+ renameFolder(relativeUrl, body, callback) {
1534
+ const meth = 'adapter-renameFolder';
1535
+ const origin = `${this.id}-${meth}`;
1536
+ log.trace(origin);
1537
+
1538
+ if (this.suspended && this.suspendMode === 'error') {
1539
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1540
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1541
+ return callback(null, errorObj);
1542
+ }
1543
+
1544
+ /* HERE IS WHERE YOU VALIDATE DATA */
1545
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1546
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1547
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1548
+ return callback(null, errorObj);
1549
+ }
1550
+ if (body === undefined || body === null || body === '') {
1551
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
1552
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1553
+ return callback(null, errorObj);
1554
+ }
1555
+
1556
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1557
+
1558
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1559
+ const queryParamsAvailable = {};
1560
+ const queryParams = {};
1561
+ const pathVars = [pathStr];
1562
+ const bodyVars = body;
1563
+
1564
+ // loop in template. long callback arg name to avoid identifier conflicts
1565
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1566
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1567
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1568
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1569
+ }
1570
+ });
1571
+
1572
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1573
+ // see adapter code documentation for more information on the request object's fields
1574
+ const reqObj = {
1575
+ payload: bodyVars,
1576
+ uriPathVars: pathVars,
1577
+ uriQuery: queryParams
1578
+ };
1579
+
1580
+ try {
1581
+ // Make the call -
1582
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1583
+ return this.requestHandlerInst.identifyRequest('Folders', 'renameFolder', reqObj, true, (irReturnData, irReturnError) => {
1584
+ // if we received an error or their is no response on the results
1585
+ // return an error
1586
+ if (irReturnError) {
1587
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1588
+ return callback(null, irReturnError);
1589
+ }
1590
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1591
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['renameFolder'], null, null, null);
1592
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1593
+ return callback(null, errorObj);
1594
+ }
1595
+
1596
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1597
+ // return the response
1598
+ return callback(irReturnData, null);
1599
+ });
1600
+ } catch (ex) {
1601
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1602
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1603
+ return callback(null, errorObj);
1604
+ }
1605
+ }
1606
+
1607
+ /**
1608
+ * @function getFilesByFolder
1609
+ * @pronghornType method
1610
+ * @name getFilesByFolder
1611
+ * @summary getFilesByFolder
1612
+ *
1613
+ * @param {string} relativeUrl - relativeUrl param
1614
+ * @param {getCallback} callback - a callback function to return the result
1615
+ * @return {object} results - An object containing the response of the action
1616
+ *
1617
+ * @route {POST} /getFilesByFolder
1618
+ * @roles admin
1619
+ * @task true
1620
+ */
1621
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1622
+ getFilesByFolder(relativeUrl, callback) {
1623
+ const meth = 'adapter-getFilesByFolder';
1624
+ const origin = `${this.id}-${meth}`;
1625
+ log.trace(origin);
1626
+
1627
+ if (this.suspended && this.suspendMode === 'error') {
1628
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1629
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1630
+ return callback(null, errorObj);
1631
+ }
1632
+
1633
+ /* HERE IS WHERE YOU VALIDATE DATA */
1634
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1635
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1636
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1637
+ return callback(null, errorObj);
1638
+ }
1639
+
1640
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1641
+
1642
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1643
+ const queryParamsAvailable = {};
1644
+ const queryParams = {};
1645
+ const pathVars = [pathStr];
1646
+ const bodyVars = {};
1647
+
1648
+ // loop in template. long callback arg name to avoid identifier conflicts
1649
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1650
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1651
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1652
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1653
+ }
1654
+ });
1655
+
1656
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1657
+ // see adapter code documentation for more information on the request object's fields
1658
+ const reqObj = {
1659
+ payload: bodyVars,
1660
+ uriPathVars: pathVars,
1661
+ uriQuery: queryParams
1662
+ };
1663
+
1664
+ try {
1665
+ // Make the call -
1666
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1667
+ return this.requestHandlerInst.identifyRequest('Files', 'getFilesByFolder', reqObj, true, (irReturnData, irReturnError) => {
1668
+ // if we received an error or their is no response on the results
1669
+ // return an error
1670
+ if (irReturnError) {
1671
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1672
+ return callback(null, irReturnError);
1673
+ }
1674
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1675
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFilesByFolder'], null, null, null);
1676
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1677
+ return callback(null, errorObj);
1678
+ }
1679
+
1680
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1681
+ // return the response
1682
+ return callback(irReturnData, null);
1683
+ });
1684
+ } catch (ex) {
1685
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1686
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1687
+ return callback(null, errorObj);
1688
+ }
1689
+ }
1690
+
1691
+ /**
1692
+ * @function getFile
1693
+ * @pronghornType method
1694
+ * @name getFile
1695
+ * @summary getFile
1696
+ *
1697
+ * @param {string} relativeUrl - relativeUrl param
1698
+ * @param {string} fileName - fileName param
1699
+ * @param {getCallback} callback - a callback function to return the result
1700
+ * @return {object} results - An object containing the response of the action
1701
+ *
1702
+ * @route {POST} /getFile
1703
+ * @roles admin
1704
+ * @task true
1705
+ */
1706
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1707
+ getFile(relativeUrl, fileName, callback) {
1708
+ const meth = 'adapter-getFile';
1709
+ const origin = `${this.id}-${meth}`;
1710
+ log.trace(origin);
1711
+
1712
+ if (this.suspended && this.suspendMode === 'error') {
1713
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1714
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1715
+ return callback(null, errorObj);
1716
+ }
1717
+
1718
+ /* HERE IS WHERE YOU VALIDATE DATA */
1719
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1720
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1721
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1722
+ return callback(null, errorObj);
1723
+ }
1724
+ if (fileName === undefined || fileName === null || fileName === '') {
1725
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['fileName'], null, null, null);
1726
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1727
+ return callback(null, errorObj);
1728
+ }
1729
+
1730
+ const path1 = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1731
+ const path2 = `Files('${fileName}')`;
1732
+
1733
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1734
+ const queryParamsAvailable = {};
1735
+ const queryParams = {};
1736
+ const pathVars = [path1, path2];
1737
+ const bodyVars = {};
1738
+
1739
+ // loop in template. long callback arg name to avoid identifier conflicts
1740
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1741
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1742
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1743
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1744
+ }
1745
+ });
1746
+
1747
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1748
+ // see adapter code documentation for more information on the request object's fields
1749
+ const reqObj = {
1750
+ payload: bodyVars,
1751
+ uriPathVars: pathVars,
1752
+ uriQuery: queryParams
1753
+ };
1754
+
1755
+ try {
1756
+ // Make the call -
1757
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1758
+ return this.requestHandlerInst.identifyRequest('Files', 'getFile', reqObj, true, (irReturnData, irReturnError) => {
1759
+ // if we received an error or their is no response on the results
1760
+ // return an error
1761
+ if (irReturnError) {
1762
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1763
+ return callback(null, irReturnError);
1764
+ }
1765
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1766
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFile'], null, null, null);
1767
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1768
+ return callback(null, errorObj);
1769
+ }
1770
+
1771
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1772
+ // return the response
1773
+ return callback(irReturnData, null);
1774
+ });
1775
+ } catch (ex) {
1776
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1777
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1778
+ return callback(null, errorObj);
1779
+ }
1780
+ }
1781
+
1782
+ /**
1783
+ * @function getFileByFileUrl
1784
+ * @pronghornType method
1785
+ * @name getFileByFileUrl
1786
+ * @summary getFileByFileUrl
1787
+ *
1788
+ * @param {string} relativeUrl - relativeUrl param
1789
+ * @param {getCallback} callback - a callback function to return the result
1790
+ * @return {object} results - An object containing the response of the action
1791
+ *
1792
+ * @route {POST} /getFileByFileUrl
1793
+ * @roles admin
1794
+ * @task true
1795
+ */
1796
+ /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
1797
+ getFileByFileUrl(relativeUrl, callback) {
1798
+ const meth = 'adapter-getFileByFileUrl';
1799
+ const origin = `${this.id}-${meth}`;
1800
+ log.trace(origin);
1801
+
1802
+ if (this.suspended && this.suspendMode === 'error') {
1803
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
1804
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1805
+ return callback(null, errorObj);
1806
+ }
1807
+
1808
+ /* HERE IS WHERE YOU VALIDATE DATA */
1809
+ if (relativeUrl === undefined || relativeUrl === null || relativeUrl === '') {
1810
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['relativeUrl'], null, null, null);
1811
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1812
+ return callback(null, errorObj);
1813
+ }
1814
+
1815
+ const pathStr = `GetFolderByServerRelativeUrl('${relativeUrl}')`;
1816
+
1817
+ /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
1818
+ const queryParamsAvailable = {};
1819
+ const queryParams = {};
1820
+ const pathVars = [pathStr];
1821
+ const bodyVars = {};
1822
+
1823
+ // loop in template. long callback arg name to avoid identifier conflicts
1824
+ Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
1825
+ if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
1826
+ && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
1827
+ queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
1828
+ }
1829
+ });
1830
+
1831
+ // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
1832
+ // see adapter code documentation for more information on the request object's fields
1833
+ const reqObj = {
1834
+ payload: bodyVars,
1835
+ uriPathVars: pathVars,
1836
+ uriQuery: queryParams
1837
+ };
1838
+
1839
+ try {
1840
+ // Make the call -
1841
+ // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
1842
+ return this.requestHandlerInst.identifyRequest('Files', 'getFileByFileUrl', reqObj, true, (irReturnData, irReturnError) => {
1843
+ // if we received an error or their is no response on the results
1844
+ // return an error
1845
+ if (irReturnError) {
1846
+ /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
1847
+ return callback(null, irReturnError);
1848
+ }
1849
+ if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
1850
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getFileByFileUrl'], null, null, null);
1851
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1852
+ return callback(null, errorObj);
1853
+ }
1854
+
1855
+ /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
1856
+ // return the response
1857
+ return callback(irReturnData, null);
1858
+ });
1859
+ } catch (ex) {
1860
+ const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
1861
+ log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
1862
+ return callback(null, errorObj);
1863
+ }
1864
+ }
1865
+ }
1866
+
1867
+ module.exports = Sharepoint;