Merge pull request #49 from CloudBoltSoftware/feature/ENG-23580-api-helper-custom-forms-phase1

ENG-23580 initial api helper for custom forms

Author: ehussm

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudbolt/cb-api-helper",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "scripts": {
     "co:login": "aws sso login && aws codeartifact login --tool npm --repository cloudbolt-npm --domain cloudbolt --domain-owner 499620025628",
     "husky:install": "husky install",

package.json

@@ -0,0 +1,19 @@
+import crud from '../../../crudOperations'
+
+const URL = 'v3/cmp/customForms'
+
+export default {
+  /**
+   * Retrieve a list of existing Custom Forms
+   * @param options anything parsable by URLSearchParams. See useful options here https://docs.cloudbolt.io/articles/#!cloudbolt-latest-docs/api-conventions/a/h2__904191799
+   * @returns {Promise} resolves with a list of existing Branded Portals
+   */
+  list: (options) => crud.getItems(URL, options),
+
+  /**
+   * Retrieve an existing Custom Form by id
+   * @param {string} id or global_id
+   * @returns {Promise} resolves with a cloudbolt API Response object of the Custom Form object
+   */
+  get: (id) => crud.getItemById(URL, id)
+}

src/api/services/v3/cmp/CustomFormsService.js

@@ -0,0 +1,18 @@
+import { baseApi } from '../../../baseApi'
+import CustomFormsService from './CustomFormsService'
+
+test('list calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'get').mockResolvedValue({
+    data: { hello: 'world' }
+  })
+  await CustomFormsService.list()
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/customForms/')
+})
+
+test('get calls the correct endpoint', async () => {
+  const mockFn = jest.spyOn(baseApi, 'get').mockResolvedValue({
+    data: { hello: 'world' }
+  })
+  await CustomFormsService.get('customForm-id')
+  expect(mockFn).toHaveBeenCalledWith('/v3/cmp/customForms/customForm-id/')
+})

src/api/services/v3/cmp/CustomFormsService.test.js

@@ -6,6 +6,7 @@ import BlueprintsService from './BlueprintsService'
 import BrandedPortalsService from './BrandedPortalsService'
 import CatalogBlueprintsService from './CatalogBlueprintsService'
 import CitService from './CitService'
+import CustomFormsService from './CustomFormsService'
 import EnvironmentsService from './EnvironmentsService'
 import EulaService from './EulaService'
 import GroupsService from './GroupsService'
@@ -47,6 +48,7 @@ export default {
   brandedPortals: BrandedPortalsService,
   catalogBlueprints: CatalogBlueprintsService,
   citService: CitService,
+  customForms: CustomFormsService,
   environments: EnvironmentsService,
   eula: EulaService,
   groups: GroupsService,

src/api/services/v3/cmp/index.js

@@ -15,6 +15,7 @@ const services = [
   'brandedPortals',
   'catalogBlueprints',
   'citService',
+  'customForms',
   'environments',
   'eula',
   'groups',