@itentialopensource/adapter-calix_cloud_devportal 0.1.1 → 0.2.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.
Files changed (50) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/AUTH.md +13 -12
  4. package/CALLS.md +82 -107
  5. package/CHANGELOG.md +8 -1
  6. package/CONTRIBUTING.md +1 -160
  7. package/ENHANCE.md +2 -2
  8. package/README.md +31 -22
  9. package/SYSTEMINFO.md +15 -6
  10. package/adapter.js +160 -330
  11. package/adapterBase.js +538 -873
  12. package/changelogs/CHANGELOG.md +9 -0
  13. package/metadata.json +57 -0
  14. package/package.json +22 -25
  15. package/pronghorn.json +474 -142
  16. package/propertiesSchema.json +453 -40
  17. package/refs?service=git-upload-pack +0 -0
  18. package/report/adapter-openapi.json +9420 -0
  19. package/report/adapter-openapi.yaml +8453 -0
  20. package/report/adapterInfo.json +8 -8
  21. package/report/updateReport1691507357331.json +120 -0
  22. package/report/updateReport1692202394525.json +120 -0
  23. package/report/updateReport1694460227836.json +120 -0
  24. package/report/updateReport1698420377491.json +120 -0
  25. package/sampleProperties.json +64 -2
  26. package/test/integration/adapterTestBasicGet.js +1 -1
  27. package/test/integration/adapterTestConnectivity.js +91 -42
  28. package/test/integration/adapterTestIntegration.js +130 -2
  29. package/test/unit/adapterBaseTestUnit.js +388 -313
  30. package/test/unit/adapterTestUnit.js +307 -109
  31. package/utils/adapterInfo.js +1 -1
  32. package/utils/addAuth.js +1 -1
  33. package/utils/artifactize.js +1 -1
  34. package/utils/checkMigrate.js +1 -1
  35. package/utils/entitiesToDB.js +1 -0
  36. package/utils/findPath.js +1 -1
  37. package/utils/methodDocumentor.js +71 -23
  38. package/utils/modify.js +13 -15
  39. package/utils/packModificationScript.js +1 -1
  40. package/utils/taskMover.js +309 -0
  41. package/utils/tbScript.js +3 -10
  42. package/utils/tbUtils.js +2 -3
  43. package/utils/testRunner.js +1 -1
  44. package/utils/troubleshootingAdapter.js +1 -3
  45. package/.gitlab/.gitkeep +0 -0
  46. package/.gitlab/issue_templates/.gitkeep +0 -0
  47. package/.gitlab/issue_templates/Default.md +0 -17
  48. package/.gitlab/issue_templates/bugReportTemplate.md +0 -76
  49. package/.gitlab/issue_templates/featureRequestTemplate.md +0 -14
  50. package/workflows/README.md +0 -3
package/.eslintignore CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  .nyc_output/*
3
2
  backup/*
4
3
  coverage/*
package/.jshintrc CHANGED
@@ -0,0 +1,3 @@
1
+ {
2
+ "esversion": 6
3
+ }
package/AUTH.md CHANGED
@@ -1,31 +1,31 @@
1
- ## Authenticating Calix_cloud_devportal Adapter
1
+ ## Authenticating Calix Developer Portal Adapter
2
2
 
3
- This document will go through the steps for authenticating the Calix_cloud_devportal adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>.
3
+ This document will go through the steps for authenticating the Calix Developer Portal adapter with OAuth Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>.
4
4
 
5
- ### Basic Authentication
6
- The Calix_cloud_devportal adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
5
+ ### OAuth Authentication
6
+ The Calix Developer Portal adapter requires OAuth Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
7
7
 
8
8
  STEPS
9
- 1. Ensure you have access to a Calix_cloud_devportal server and that it is running
9
+ 1. Ensure you have access to a Calix Developer Portal server and that it is running
10
10
  2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
11
11
  3. Use the properties below for the ```properties.authentication``` field
12
12
  ```json
13
13
  "authentication": {
14
- "auth_method": "basic user_password",
14
+ "auth_method": "request_token",
15
15
  "username": "<username>",
16
16
  "password": "<password>",
17
- "token": "",
18
17
  "token_timeout": 1800000,
19
18
  "token_cache": "local",
20
19
  "invalid_token_error": 401,
21
- "auth_field": "header.headers.Authorization",
22
- "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
20
+ "auth_field": "header.headers.X-Calix-AccessToken",
21
+ "auth_field_format": "{token}",
23
22
  "auth_logging": false,
24
- "client_id": "",
25
- "client_secret": "",
26
- "grant_type": ""
23
+ "client_secret": "<client_secret>",
24
+ "grant_type": "password"
27
25
  }
28
26
  ```
27
+ you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_token.
28
+
29
29
  4. Restart the adapter. If your properties were set correctly, the adapter should go online.
30
30
 
31
31
  ### Troubleshooting
@@ -36,4 +36,5 @@ STEPS
36
36
  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
37
37
  - The FULL BODY log to make sure the payload is accurate.
38
38
  - The CALL RETURN log to see what the other system is telling us.
39
+ - Credentials should be ** masked ** by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
39
40
  - Remember when you are done to turn auth_logging off as you do not want to log credentials.
package/CALLS.md CHANGED
@@ -19,7 +19,7 @@ These are adapter methods that IAP or you might use. There are some other method
19
19
  </tr>
20
20
  <tr>
21
21
  <td style="padding:15px">healthCheck(callback)</td>
22
- <td style="padding:15px">This call ensures that the adapter can communicate with Calix_cloud_devportal. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
22
+ <td style="padding:15px">This call ensures that the adapter can communicate with Adapter for Calix Developer Portal. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
23
23
  <td style="padding:15px">No</td>
24
24
  </tr>
25
25
  <tr>
@@ -29,7 +29,7 @@ These are adapter methods that IAP or you might use. There are some other method
29
29
  </tr>
30
30
  <tr>
31
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 Calix_cloud_devportal.</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 Adapter for Calix Developer Portal.</td>
33
33
  <td style="padding:15px">No</td>
34
34
  </tr>
35
35
  <tr>
@@ -37,11 +37,6 @@ These are adapter methods that IAP or you might use. There are some other method
37
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
38
  <td style="padding:15px">Yes</td>
39
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
40
  <tr>
46
41
  <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
47
42
  <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
@@ -57,12 +52,16 @@ These are adapter methods that IAP or you might use. There are some other method
57
52
  <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
58
53
  <td style="padding:15px">Yes</td>
59
54
  </tr>
55
+ <tr>
56
+ <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
57
+ <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
58
+ <td style="padding:15px">Yes</td>
59
+ </tr>
60
60
  <tr>
61
61
  <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
62
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
63
  <td style="padding:15px">Yes</td>
64
64
  </tr>
65
-
66
65
  <tr>
67
66
  <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
68
67
  <td style="padding:15px">This call will return the results of a healthcheck.</td>
@@ -83,6 +82,21 @@ These are adapter methods that IAP or you might use. There are some other method
83
82
  <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
84
83
  <td style="padding:15px">Yes</td>
85
84
  </tr>
85
+ <tr>
86
+ <td style="padding:15px">iapDeactivateTasks(tasks, callback)</td>
87
+ <td style="padding:15px">This call provides the ability to remove tasks from the adapter.</td>
88
+ <td style="padding:15px">Yes</td>
89
+ </tr>
90
+ <tr>
91
+ <td style="padding:15px">iapActivateTasks(tasks, callback)</td>
92
+ <td style="padding:15px">This call provides the ability to add deactivated tasks back into the adapter.</td>
93
+ <td style="padding:15px">Yes</td>
94
+ </tr>
95
+ <tr>
96
+ <td style="padding:15px">iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)</td>
97
+ <td style="padding:15px">This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.</td>
98
+ <td style="padding:15px">Yes</td>
99
+ </tr>
86
100
  <tr>
87
101
  <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
88
102
  <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
@@ -94,23 +108,46 @@ These are adapter methods that IAP or you might use. There are some other method
94
108
  <td style="padding:15px">Yes</td>
95
109
  </tr>
96
110
  <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>
111
+ <td style="padding:15px">iapRunAdapterLint(callback)</td>
112
+ <td style="padding:15px">Runs lint on the addapter and provides the information back.</td>
113
+ <td style="padding:15px">Yes</td>
100
114
  </tr>
101
115
  <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>
116
+ <td style="padding:15px">iapRunAdapterTests(callback)</td>
117
+ <td style="padding:15px">Runs baseunit and unit tests on the adapter and provides the information back.</td>
118
+ <td style="padding:15px">Yes</td>
105
119
  </tr>
106
120
  <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>
121
+ <td style="padding:15px">iapGetAdapterInventory(callback)</td>
122
+ <td style="padding:15px">This call provides some inventory related information about the adapter.</td>
123
+ <td style="padding:15px">Yes</td>
110
124
  </tr>
111
125
  </table>
112
126
  <br>
127
+
128
+ ### Adapter Cache Calls
129
+
130
+ These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
113
131
 
132
+ <table border="1" class="bordered-table">
133
+ <tr>
134
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
135
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
136
+ <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
137
+ </tr>
138
+ <tr>
139
+ <td style="padding:15px">iapPopulateEntityCache(entityTypes, callback)</td>
140
+ <td style="padding:15px">This call populates the adapter cache.</td>
141
+ <td style="padding:15px">Yes</td>
142
+ </tr>
143
+ <tr>
144
+ <td style="padding:15px">iapRetrieveEntitiesCache(entityType, options, callback)</td>
145
+ <td style="padding:15px">This call retrieves the specific items from the adapter cache.</td>
146
+ <td style="padding:15px">Yes</td>
147
+ </tr>
148
+ </table>
149
+ <br>
150
+
114
151
  ### Adapter Broker Calls
115
152
 
116
153
  These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
@@ -129,32 +166,31 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
129
166
  <tr>
130
167
  <td style="padding:15px">getDevice(deviceName, callback)</td>
131
168
  <td style="padding:15px">This call returns the details of the requested device.</td>
132
- <td style="padding:15px">Yes</td>
169
+ <td style="padding:15px">No</td>
133
170
  </tr>
134
171
  <tr>
135
172
  <td style="padding:15px">getDevicesFiltered(options, callback)</td>
136
173
  <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>
174
+ <td style="padding:15px">No</td>
138
175
  </tr>
139
176
  <tr>
140
177
  <td style="padding:15px">isAlive(deviceName, callback)</td>
141
178
  <td style="padding:15px">This call returns whether the device status is active</td>
142
- <td style="padding:15px">Yes</td>
179
+ <td style="padding:15px">No</td>
143
180
  </tr>
144
181
  <tr>
145
182
  <td style="padding:15px">getConfig(deviceName, format, callback)</td>
146
183
  <td style="padding:15px">This call returns the configuration for the selected device.</td>
147
- <td style="padding:15px">Yes</td>
184
+ <td style="padding:15px">No</td>
148
185
  </tr>
149
186
  <tr>
150
187
  <td style="padding:15px">iapGetDeviceCount(callback)</td>
151
188
  <td style="padding:15px">This call returns the count of devices.</td>
152
- <td style="padding:15px">Yes</td>
189
+ <td style="padding:15px">No</td>
153
190
  </tr>
154
191
  </table>
155
192
  <br>
156
193
 
157
-
158
194
  ### Specific Adapter Calls
159
195
 
160
196
  Specific adapter calls are built based on the API of the Calix_cloud_devportal. 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.
@@ -168,7 +204,7 @@ Specific adapter calls are built based on the API of the Calix_cloud_devportal.
168
204
  </tr>
169
205
  <tr>
170
206
  <td style="padding:15px">getCalloutcomeSubscriberCallOutcome(subscriberLocationId, extref, callback)</td>
171
- <td style="padding:15px">Get call outcome data for Calix partners</td>
207
+ <td style="padding:15px">Get call outcome data</td>
172
208
  <td style="padding:15px">{base_path}/{version}/calloutcome/subscriber/call-outcome?{query}</td>
173
209
  <td style="padding:15px">Yes</td>
174
210
  </tr>
@@ -180,10 +216,7 @@ Specific adapter calls are built based on the API of the Calix_cloud_devportal.
180
216
  </tr>
181
217
  <tr>
182
218
  <td style="padding:15px">getNetPerfTestCafIITest(name, callback)</td>
183
- <td style="padding:15px">This is for externl troubleshooting purposes only.
184
- When creating a new test or changing the name of an existing name, a client needs to make sure the name is unique within the org.
185
- The uniqueness check can be done by retrieving existing test with the "name" query parameter.
186
- The response body will always be a JSON array with 0 or more test instance(s).</td>
219
+ <td style="padding:15px">Retrieve all existing CAF II tests, or a single test instance by orgId and name, or for a given dat</td>
187
220
  <td style="padding:15px">{base_path}/{version}/net-perf-test/cafIITest?{query}</td>
188
221
  <td style="padding:15px">Yes</td>
189
222
  </tr>
@@ -201,8 +234,7 @@ The response body will always be a JSON array with 0 or more test instance(s).</
201
234
  </tr>
202
235
  <tr>
203
236
  <td style="padding:15px">putNetPerfTestCafIITestId(id, body, callback)</td>
204
- <td style="padding:15px">Misc notes:
205
- - Editing is not allowed once test has started.</td>
237
+ <td style="padding:15px">Update an existing test</td>
206
238
  <td style="padding:15px">{base_path}/{version}/net-perf-test/cafIITest/{pathv1}?{query}</td>
207
239
  <td style="padding:15px">Yes</td>
208
240
  </tr>
@@ -225,23 +257,20 @@ The response body will always be a JSON array with 0 or more test instance(s).</
225
257
  <td style="padding:15px">Yes</td>
226
258
  </tr>
227
259
  <tr>
228
- <td style="padding:15px">getNetPerfTestOoklaServer(country = US, callback)</td>
260
+ <td style="padding:15px">getNetPerfTestOoklaServer(country = 'US', callback)</td>
229
261
  <td style="padding:15px">Retrieve all Ookla servers</td>
230
262
  <td style="padding:15px">{base_path}/{version}/net-perf-test/ooklaServer?{query}</td>
231
263
  <td style="padding:15px">Yes</td>
232
264
  </tr>
233
265
  <tr>
234
266
  <td style="padding:15px">getNetPerfTestTestResultZipExternal(testId, callback)</td>
235
- <td style="padding:15px">Click on the 'Download File -> Name the file as 'test.zip' and Save as Zip'</td>
267
+ <td style="padding:15px">Retrieve both Speed Test and Latency Test results as a zip file</td>
236
268
  <td style="padding:15px">{base_path}/{version}/net-perf-test/testResult/zip/external?{query}</td>
237
269
  <td style="padding:15px">Yes</td>
238
270
  </tr>
239
271
  <tr>
240
- <td style="padding:15px">getBillingSubscribers(devices, account, phone, email, region, billingStatus = Active, withDevices, withServices, offset, limit, callback)</td>
241
- <td style="padding:15px">Misc Notes:
242
- - When querying via the "devices" query parameter, all other query parameters will be ignored
243
- - The list of associated device(s), e.g. the "devices" field, will not be included in the response. To include the "devices" field in the response, the "withDevices" query parameter must be set to true explicitly
244
- - The list of service(s), e.g. the "services" field, will not be included in the response. To include the "services" field in the response, the "withServices" query parameter ...(description truncated)</td>
272
+ <td style="padding:15px">getBillingSubscribers(devices, account, phone, email, region, billingStatus = 'Active', withDevices, withServices, offset, limit, callback)</td>
273
+ <td style="padding:15px">Retrieve all subscriber(s) that match all the given query criteria</td>
245
274
  <td style="padding:15px">{base_path}/{version}/billing/subscribers?{query}</td>
246
275
  <td style="padding:15px">Yes</td>
247
276
  </tr>
@@ -259,8 +288,7 @@ The response body will always be a JSON array with 0 or more test instance(s).</
259
288
  </tr>
260
289
  <tr>
261
290
  <td style="padding:15px">putBillingSubscribersSubscriberId(subscriberId, body, callback)</td>
262
- <td style="padding:15px">Misc Notes:
263
- - If there are currently 1 or more device(s) assocated with the subcriber, and the update request does not contain the "devices" field, the "devices" field will be preserved during the update.</td>
291
+ <td style="padding:15px">Update an existing subscriber by subscriberId.</td>
264
292
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}?{query}</td>
265
293
  <td style="padding:15px">Yes</td>
266
294
  </tr>
@@ -278,7 +306,7 @@ The response body will always be a JSON array with 0 or more test instance(s).</
278
306
  </tr>
279
307
  <tr>
280
308
  <td style="padding:15px">putBillingSubscribersSubscriberIdDevices(subscriberId, deviceList, callback)</td>
281
- <td style="padding:15px">Update the entire list of device(s) that are associated with a subscriber with the new list in the request body</td>
309
+ <td style="padding:15px">Update associated device list</td>
282
310
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/devices?{query}</td>
283
311
  <td style="padding:15px">Yes</td>
284
312
  </tr>
@@ -314,7 +342,7 @@ The response body will always be a JSON array with 0 or more test instance(s).</
314
342
  </tr>
315
343
  <tr>
316
344
  <td style="padding:15px">postBillingSubscribersSubscriberIdFccIdentifiers(subscriberId, body, callback)</td>
317
- <td style="padding:15px">Create a new FCC identifier.</td>
345
+ <td style="padding:15px">Create a new FCC identifier for the subscriber.</td>
318
346
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/fccIdentifiers?{query}</td>
319
347
  <td style="padding:15px">Yes</td>
320
348
  </tr>
@@ -332,15 +360,13 @@ The response body will always be a JSON array with 0 or more test instance(s).</
332
360
  </tr>
333
361
  <tr>
334
362
  <td style="padding:15px">putBillingSubscribersSubscriberIdServices(subscriberId, ignoreDuplicates, body, callback)</td>
335
- <td style="padding:15px">Update the entire list of service(s) for a subscriber location with the new list in the request body</td>
363
+ <td style="padding:15px">Update the entire service list for a subscriber location</td>
336
364
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/services?{query}</td>
337
365
  <td style="padding:15px">Yes</td>
338
366
  </tr>
339
367
  <tr>
340
368
  <td style="padding:15px">postBillingSubscribersSubscriberIdServices(subscriberId, body, callback)</td>
341
- <td style="padding:15px">Each subscriber location can only have up to 1 data service, up to 1 video service, and up to 1 voice service.
342
-
343
- When you want to apply the service, a.k.a activate the service, you must input `"activate": true` with appropriate parameters.</td>
369
+ <td style="padding:15px">Add a new service to a subscriber location</td>
344
370
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/services?{query}</td>
345
371
  <td style="padding:15px">Yes</td>
346
372
  </tr>
@@ -375,16 +401,14 @@ When you want to apply the service, a.k.a activate the service, you must input `
375
401
  <td style="padding:15px">Yes</td>
376
402
  </tr>
377
403
  <tr>
378
- <td style="padding:15px">getBillingSubscribersSubscriberIdAppServicesAppServiceName(subscriberId, appServiceName = ProtectIQ, callback)</td>
404
+ <td style="padding:15px">getBillingSubscribersSubscriberIdAppServicesAppServiceName(subscriberId, appServiceName = 'ProtectIQ', callback)</td>
379
405
  <td style="padding:15px">Retrieve an existing application service setting by subscriberId and service name</td>
380
406
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/appServices/{pathv2}?{query}</td>
381
407
  <td style="padding:15px">Yes</td>
382
408
  </tr>
383
409
  <tr>
384
- <td style="padding:15px">putBillingSubscribersSubscriberIdAppServicesAppServiceName(subscriberId, appServiceName = ProtectIQ, body, callback)</td>
385
- <td style="padding:15px">Misc Notes:
386
- - If there is no existing app service found for the specified app service name, it will be created.
387
- - If there is already existing app service for the specified app service name, it will be updated.</td>
410
+ <td style="padding:15px">putBillingSubscribersSubscriberIdAppServicesAppServiceName(subscriberId, appServiceName = 'ProtectIQ', body, callback)</td>
411
+ <td style="padding:15px">Create a new application service setting or update an existing application service setting for a su</td>
388
412
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/appServices/{pathv2}?{query}</td>
389
413
  <td style="padding:15px">Yes</td>
390
414
  </tr>
@@ -444,31 +468,7 @@ When you want to apply the service, a.k.a activate the service, you must input `
444
468
  </tr>
445
469
  <tr>
446
470
  <td style="padding:15px">postBillingSubscribersSubscriberIdManagedServiceArlo(subscriberId, body, callback)</td>
447
- <td style="padding:15px">Create an Arlo Service account for the subscriber specified by the `subscriberId`.
448
- The attributes of Arlo Service account are from standardized subscriber attributes, e.g.
449
- * name
450
- * firstName
451
- * lastName
452
- * **email**
453
- * phone
454
- * serviceAddress
455
- * street
456
- * streetLine2
457
- * city
458
- * state
459
- * postcode
460
- * country
461
- * businessName
462
- * billingStreet
463
- * billingStreetLine2
464
- * billingCity
465
- * billingState
466
- * billingPostcode
467
- * billingCountry
468
- * serviceCategory
469
- * **planCode**
470
-
471
- Highlighte...(description truncated)</td>
471
+ <td style="padding:15px">Create the Arlo Service for a subscriber</td>
472
472
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/managed-service/arlo?{query}</td>
473
473
  <td style="padding:15px">Yes</td>
474
474
  </tr>
@@ -485,36 +485,14 @@ Highlighte...(description truncated)</td>
485
485
  <td style="padding:15px">Yes</td>
486
486
  </tr>
487
487
  <tr>
488
- <td style="padding:15px">putBillingSubscribersSubscriberIdManagedServiceServify(subscriberId, planCode = SERVIFYCAREBRONZE, callback)</td>
488
+ <td style="padding:15px">putBillingSubscribersSubscriberIdManagedServiceServify(subscriberId, planCode = 'SERVIFYCAREBRONZE', callback)</td>
489
489
  <td style="padding:15px">Update Servify Contract Plan for a subscriber</td>
490
490
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/managed-service/servify?{query}</td>
491
491
  <td style="padding:15px">Yes</td>
492
492
  </tr>
493
493
  <tr>
494
494
  <td style="padding:15px">postBillingSubscribersSubscriberIdManagedServiceServify(subscriberId, body, callback)</td>
495
- <td style="padding:15px">Create a Servify Contract for the subscriber specified by the `subscriberId`.
496
- The attributes of Servify Contract are from standardized subscriber attributes, e.g.
497
- * name
498
- * **firstName**
499
- * **lastName**
500
- * **email**
501
- * phone
502
- * **serviceAddress**
503
- * street
504
- * streetLine2
505
- * **city**
506
- * **state**
507
- * **postcode**
508
- * country
509
- * businessName
510
- * billingStreet
511
- * billingStreetLine2
512
- * billingCity
513
- * billingState
514
- * billingPostcode
515
- * billingCountry
516
- * serviceCategory
517
- * **planCod...(description truncated)</td>
495
+ <td style="padding:15px">Create Servify Contract for a subscriber</td>
518
496
  <td style="padding:15px">{base_path}/{version}/billing/subscribers/{pathv1}/managed-service/servify?{query}</td>
519
497
  <td style="padding:15px">Yes</td>
520
498
  </tr>
@@ -592,22 +570,19 @@ The attributes of Servify Contract are from standardized subscriber attributes,
592
570
  </tr>
593
571
  <tr>
594
572
  <td style="padding:15px">getBillingSupportOperatorSecondarynetwork(serialNumber, subscriberId, callback)</td>
595
- <td style="padding:15px">* encryptionType (0 none, 1 WPA2-Personal, 2 WPA-WPA2-Personal, 5 WPA2-WPA3-Personal, 6 WPA3-Personal)
596
- * type (1 guest, 2 WFH, 3 custom unified, 4 custom 2.4GHz, 5 custom 5GHz, 6 custom 6GHz)</td>
573
+ <td style="padding:15px">Retrieve secondarynetwork by subscriberId or RG serialNumber</td>
597
574
  <td style="padding:15px">{base_path}/{version}/billing/support/operator/secondarynetwork?{query}</td>
598
575
  <td style="padding:15px">Yes</td>
599
576
  </tr>
600
577
  <tr>
601
578
  <td style="padding:15px">putBillingSupportOperatorSecondarynetwork(serialNumber, subscriberId, body, callback)</td>
602
- <td style="padding:15px">* encryptionType (0 none, 1 WPA2-Personal, 2 WPA-WPA2-Personal, 5 WPA2-WPA3-Personal, 6 WPA3-Personal)
603
- * type (1 guest, 2 WFH, 3 custom unified, 4 custom 2.4GHz, 5 custom 5GHz, 6 custom 6GHz)</td>
579
+ <td style="padding:15px">Update secondarynetwork by subscriberId or RG serialNumber</td>
604
580
  <td style="padding:15px">{base_path}/{version}/billing/support/operator/secondarynetwork?{query}</td>
605
581
  <td style="padding:15px">Yes</td>
606
582
  </tr>
607
583
  <tr>
608
584
  <td style="padding:15px">postBillingSupportOperatorSecondarynetwork(serialNumber, subscriberId, body, callback)</td>
609
- <td style="padding:15px">* encryptionType (0 none, 1 WPA2-Personal, 2 WPA-WPA2-Personal, 5 WPA2-WPA3-Personal, 6 WPA3-Personal)
610
- * type (1 guest, 2 WFH, 3 custom unified, 4 custom 2.4GHz, 5 custom 5GHz, 6 custom 6GHz)</td>
585
+ <td style="padding:15px">Create secondarynetwork by subscriberId or RG serialNumber</td>
611
586
  <td style="padding:15px">{base_path}/{version}/billing/support/operator/secondarynetwork?{query}</td>
612
587
  <td style="padding:15px">Yes</td>
613
588
  </tr>
@@ -618,8 +593,8 @@ The attributes of Servify Contract are from standardized subscriber attributes,
618
593
  <td style="padding:15px">Yes</td>
619
594
  </tr>
620
595
  <tr>
621
- <td style="padding:15px">searchServiceDefinitions(name, serviceType = DATA, callback)</td>
622
- <td style="padding:15px">The GET method will retrieve the details of the service definitions</td>
596
+ <td style="padding:15px">searchServiceDefinitions(name, serviceType = 'DATA', callback)</td>
597
+ <td style="padding:15px">GET method for retrieving details of all service definitions</td>
623
598
  <td style="padding:15px">{base_path}/{version}/billing/e2e/serviceDefinitions?{query}</td>
624
599
  <td style="padding:15px">Yes</td>
625
600
  </tr>
package/CHANGELOG.md CHANGED
@@ -1,4 +1,12 @@
1
1
 
2
+ ## 0.2.0 [11-10-2023]
3
+
4
+ * Adapter Engine has been updated and the changes are being migrated to the adapter
5
+
6
+ See merge request itentialopensource/adapters/cloud/adapter-calix_cloud_devportal!3
7
+
8
+ ---
9
+
2
10
  ## 0.1.1 [04-03-2023]
3
11
 
4
12
  * Bug fixes and performance improvements
@@ -6,4 +14,3 @@
6
14
  See commit 6b92cc9
7
15
 
8
16
  ---
9
-