@salesforce/lds-adapters-industries-featurevalidation 1.124.0

package/sfdc/index.js

@@ -0,0 +1,545 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*  *******************************************************************************************
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, StoreKeyMap } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys$1, freeze: ObjectFreeze$1, create: ObjectCreate$1 } = Object;
+const { isArray: ArrayIsArray$1 } = Array;
+/**
+ * Validates an adapter config is well-formed.
+ * @param config The config to validate.
+ * @param adapter The adapter validation configuration.
+ * @param oneOf The keys the config must contain at least one of.
+ * @throws A TypeError if config doesn't satisfy the adapter's config validation.
+ */
+function validateConfig(config, adapter, oneOf) {
+    const { displayName } = adapter;
+    const { required, optional, unsupported } = adapter.parameters;
+    if (config === undefined ||
+        required.every(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify ${required.sort().join(', ')}`);
+    }
+    if (oneOf && oneOf.some(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify one of ${oneOf.sort().join(', ')}`);
+    }
+    if (unsupported !== undefined &&
+        unsupported.some(req => ObjectPrototypeHasOwnProperty.call(config, req))) {
+        throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
+    }
+    const supported = required.concat(optional);
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
+        throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
+    }
+}
+function untrustedIsObject(untrusted) {
+    return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray$1(untrusted) === false;
+}
+function areRequiredParametersPresent(config, configPropertyNames) {
+    return configPropertyNames.parameters.required.every(req => req in config);
+}
+const keyPrefix = 'featurevalidation';
+
+const { freeze: ObjectFreeze, keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
+const { isArray: ArrayIsArray } = Array;
+function equalsArray(a, b, equalsItem) {
+    const aLength = a.length;
+    const bLength = b.length;
+    if (aLength !== bLength) {
+        return false;
+    }
+    for (let i = 0; i < aLength; i++) {
+        if (equalsItem(a[i], b[i]) === false) {
+            return false;
+        }
+    }
+    return true;
+}
+function deepFreeze(value) {
+    // No need to freeze primitives
+    if (typeof value !== 'object' || value === null) {
+        return;
+    }
+    if (ArrayIsArray(value)) {
+        for (let i = 0, len = value.length; i < len; i += 1) {
+            deepFreeze(value[i]);
+        }
+    }
+    else {
+        const keys = ObjectKeys(value);
+        for (let i = 0, len = keys.length; i < len; i += 1) {
+            deepFreeze(value[keys[i]]);
+        }
+    }
+    ObjectFreeze(value);
+}
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+const VERSION$2 = "631aec0cb3216fffb314c3734733f29b";
+function validate$2(obj, path = 'FeatureValidationFieldValuesRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_fieldName = obj.fieldName;
+        const path_fieldName = path + '.fieldName';
+        if (typeof obj_fieldName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_fieldName + '" (at "' + path_fieldName + '")');
+        }
+        const obj_fieldValue = obj.fieldValue;
+        const path_fieldValue = path + '.fieldValue';
+        if (typeof obj_fieldValue !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_fieldValue + '" (at "' + path_fieldValue + '")');
+        }
+        const obj_message = obj.message;
+        const path_message = path + '.message';
+        if (typeof obj_message !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+        }
+        const obj_required = obj.required;
+        const path_required = path + '.required';
+        if (typeof obj_required !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_required + '" (at "' + path_required + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$3 = function FeatureValidationFieldValuesRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION$2,
+        private: [],
+        selections: [
+            {
+                name: 'fieldName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'fieldValue',
+                kind: 'Scalar'
+            },
+            {
+                name: 'message',
+                kind: 'Scalar'
+            },
+            {
+                name: 'required',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$2(existing, incoming) {
+    const existing_required = existing.required;
+    const incoming_required = incoming.required;
+    if (!(existing_required === incoming_required)) {
+        return false;
+    }
+    const existing_fieldName = existing.fieldName;
+    const incoming_fieldName = incoming.fieldName;
+    if (!(existing_fieldName === incoming_fieldName)) {
+        return false;
+    }
+    const existing_fieldValue = existing.fieldValue;
+    const incoming_fieldValue = incoming.fieldValue;
+    if (!(existing_fieldValue === incoming_fieldValue)) {
+        return false;
+    }
+    const existing_message = existing.message;
+    const incoming_message = incoming.message;
+    if (!(existing_message === incoming_message)) {
+        return false;
+    }
+    return true;
+}
+
+const VERSION$1 = "b2421cf8b77991983bf69e64a9fa0236";
+function validate$1(obj, path = 'FeatureValidationOutputDetailsRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_bpoName = obj.bpoName;
+        const path_bpoName = path + '.bpoName';
+        if (typeof obj_bpoName !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_bpoName + '" (at "' + path_bpoName + '")');
+        }
+        const obj_bpoRecordId = obj.bpoRecordId;
+        const path_bpoRecordId = path + '.bpoRecordId';
+        if (typeof obj_bpoRecordId !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_bpoRecordId + '" (at "' + path_bpoRecordId + '")');
+        }
+        const obj_featureValidationFieldValues = obj.featureValidationFieldValues;
+        const path_featureValidationFieldValues = path + '.featureValidationFieldValues';
+        if (!ArrayIsArray(obj_featureValidationFieldValues)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_featureValidationFieldValues + '" (at "' + path_featureValidationFieldValues + '")');
+        }
+        for (let i = 0; i < obj_featureValidationFieldValues.length; i++) {
+            const obj_featureValidationFieldValues_item = obj_featureValidationFieldValues[i];
+            const path_featureValidationFieldValues_item = path_featureValidationFieldValues + '[' + i + ']';
+            const referencepath_featureValidationFieldValues_itemValidationError = validate$2(obj_featureValidationFieldValues_item, path_featureValidationFieldValues_item);
+            if (referencepath_featureValidationFieldValues_itemValidationError !== null) {
+                let message = 'Object doesn\'t match FeatureValidationFieldValuesRepresentation (at "' + path_featureValidationFieldValues_item + '")\n';
+                message += referencepath_featureValidationFieldValues_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        const obj_message = obj.message;
+        const path_message = path + '.message';
+        if (typeof obj_message !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_message + '" (at "' + path_message + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const select$2 = function FeatureValidationOutputDetailsRepresentationSelect() {
+    const { selections: FeatureValidationFieldValuesRepresentation__selections, opaque: FeatureValidationFieldValuesRepresentation__opaque, } = select$3();
+    return {
+        kind: 'Fragment',
+        version: VERSION$1,
+        private: [],
+        selections: [
+            {
+                name: 'bpoName',
+                kind: 'Scalar'
+            },
+            {
+                name: 'bpoRecordId',
+                kind: 'Scalar'
+            },
+            {
+                name: 'featureValidationFieldValues',
+                kind: 'Object',
+                plural: true,
+                selections: FeatureValidationFieldValuesRepresentation__selections
+            },
+            {
+                name: 'message',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals$1(existing, incoming) {
+    const existing_bpoName = existing.bpoName;
+    const incoming_bpoName = incoming.bpoName;
+    if (!(existing_bpoName === incoming_bpoName)) {
+        return false;
+    }
+    const existing_bpoRecordId = existing.bpoRecordId;
+    const incoming_bpoRecordId = incoming.bpoRecordId;
+    if (!(existing_bpoRecordId === incoming_bpoRecordId)) {
+        return false;
+    }
+    const existing_message = existing.message;
+    const incoming_message = incoming.message;
+    if (!(existing_message === incoming_message)) {
+        return false;
+    }
+    const existing_featureValidationFieldValues = existing.featureValidationFieldValues;
+    const incoming_featureValidationFieldValues = incoming.featureValidationFieldValues;
+    const equals_featureValidationFieldValues_items = equalsArray(existing_featureValidationFieldValues, incoming_featureValidationFieldValues, (existing_featureValidationFieldValues_item, incoming_featureValidationFieldValues_item) => {
+        if (!(equals$2(existing_featureValidationFieldValues_item, incoming_featureValidationFieldValues_item))) {
+            return false;
+        }
+    });
+    if (equals_featureValidationFieldValues_items === false) {
+        return false;
+    }
+    return true;
+}
+
+const TTL = 300;
+const VERSION = "cca11a8e3ab8424bcce64057aad4f46d";
+function validate(obj, path = 'FeatureValidationOutputRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        if (obj.errorMessage !== undefined) {
+            const obj_errorMessage = obj.errorMessage;
+            const path_errorMessage = path + '.errorMessage';
+            if (typeof obj_errorMessage !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_errorMessage + '" (at "' + path_errorMessage + '")');
+            }
+        }
+        const obj_featureValidationOutputDetails = obj.featureValidationOutputDetails;
+        const path_featureValidationOutputDetails = path + '.featureValidationOutputDetails';
+        if (!ArrayIsArray(obj_featureValidationOutputDetails)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_featureValidationOutputDetails + '" (at "' + path_featureValidationOutputDetails + '")');
+        }
+        for (let i = 0; i < obj_featureValidationOutputDetails.length; i++) {
+            const obj_featureValidationOutputDetails_item = obj_featureValidationOutputDetails[i];
+            const path_featureValidationOutputDetails_item = path_featureValidationOutputDetails + '[' + i + ']';
+            const referencepath_featureValidationOutputDetails_itemValidationError = validate$1(obj_featureValidationOutputDetails_item, path_featureValidationOutputDetails_item);
+            if (referencepath_featureValidationOutputDetails_itemValidationError !== null) {
+                let message = 'Object doesn\'t match FeatureValidationOutputDetailsRepresentation (at "' + path_featureValidationOutputDetails_item + '")\n';
+                message += referencepath_featureValidationOutputDetails_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        const obj_isSuccess = obj.isSuccess;
+        const path_isSuccess = path + '.isSuccess';
+        if (typeof obj_isSuccess !== 'boolean') {
+            return new TypeError('Expected "boolean" but received "' + typeof obj_isSuccess + '" (at "' + path_isSuccess + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'FeatureValidationOutputRepresentation';
+function keyBuilder(luvio, config) {
+    return keyPrefix + '::' + RepresentationType + ':' + config.isSuccess;
+}
+function keyBuilderFromType(luvio, object) {
+    const keyParams = {
+        isSuccess: object.isSuccess
+    };
+    return keyBuilder(luvio, keyParams);
+}
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function FeatureValidationOutputRepresentationSelect() {
+    const { selections: FeatureValidationOutputDetailsRepresentation__selections, opaque: FeatureValidationOutputDetailsRepresentation__opaque, } = select$2();
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        selections: [
+            {
+                name: 'errorMessage',
+                kind: 'Scalar',
+                required: false
+            },
+            {
+                name: 'featureValidationOutputDetails',
+                kind: 'Object',
+                plural: true,
+                selections: FeatureValidationOutputDetailsRepresentation__selections
+            },
+            {
+                name: 'isSuccess',
+                kind: 'Scalar'
+            }
+        ]
+    };
+};
+function equals(existing, incoming) {
+    const existing_isSuccess = existing.isSuccess;
+    const incoming_isSuccess = incoming.isSuccess;
+    if (!(existing_isSuccess === incoming_isSuccess)) {
+        return false;
+    }
+    const existing_errorMessage = existing.errorMessage;
+    const incoming_errorMessage = incoming.errorMessage;
+    // if at least one of these optionals is defined
+    if (existing_errorMessage !== undefined || incoming_errorMessage !== undefined) {
+        // if one of these is not defined we know the other is defined and therefore
+        // not equal
+        if (existing_errorMessage === undefined || incoming_errorMessage === undefined) {
+            return false;
+        }
+        if (!(existing_errorMessage === incoming_errorMessage)) {
+            return false;
+        }
+    }
+    const existing_featureValidationOutputDetails = existing.featureValidationOutputDetails;
+    const incoming_featureValidationOutputDetails = incoming.featureValidationOutputDetails;
+    const equals_featureValidationOutputDetails_items = equalsArray(existing_featureValidationOutputDetails, incoming_featureValidationOutputDetails, (existing_featureValidationOutputDetails_item, incoming_featureValidationOutputDetails_item) => {
+        if (!(equals$1(existing_featureValidationOutputDetails_item, incoming_featureValidationOutputDetails_item))) {
+            return false;
+        }
+    });
+    if (equals_featureValidationOutputDetails_items === false) {
+        return false;
+    }
+    return true;
+}
+const ingest = function FeatureValidationOutputRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = keyBuilderFromType(luvio, input);
+    const existingRecord = store.readEntry(key);
+    const ttlToUse = TTL;
+    let incomingRecord = normalize(input, store.readEntry(key), {
+        fullPath: key,
+        parent: path.parent,
+        propertyName: path.propertyName,
+        ttl: ttlToUse
+    });
+    if (existingRecord === undefined || equals(existingRecord, incomingRecord) === false) {
+        luvio.storePublish(key, incomingRecord);
+    }
+    {
+        const storeMetadataParams = {
+            ttl: ttlToUse,
+            namespace: "featurevalidation",
+            version: VERSION,
+            representationName: RepresentationType,
+        };
+        luvio.publishStoreMetadata(key, storeMetadataParams);
+    }
+    return createLink(key);
+};
+function getTypeCacheKeys(luvio, input, fullPathFactory) {
+    const rootKeySet = new StoreKeyMap();
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = keyBuilderFromType(luvio, input);
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+    return rootKeySet;
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function getResponseCacheKeys(luvio, resourceParams, response) {
+    return getTypeCacheKeys(luvio, response);
+}
+function ingestSuccess(luvio, resourceParams, response) {
+    const { body } = response;
+    const key = keyBuilderFromType(luvio, body);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    });
+    if (process.env.NODE_ENV !== 'production') {
+        if (snapshot.state !== 'Fulfilled') {
+            throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+        }
+    }
+    return snapshot;
+}
+function createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v58.0',
+        basePath: '/connect/industries/feature-validation',
+        method: 'post',
+        body: config.body,
+        urlParams: {},
+        queryParams: {},
+        headers,
+        priority: 'normal',
+    };
+}
+
+const featureValidation_ConfigPropertyNames = {
+    displayName: 'featureValidation',
+    parameters: {
+        required: ['featureValidationInputDetails', 'useCase'],
+        optional: []
+    }
+};
+function createResourceParams(config) {
+    const resourceParams = {
+        body: {
+            featureValidationInputDetails: config.featureValidationInputDetails, useCase: config.useCase
+        }
+    };
+    return resourceParams;
+}
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    const untrustedConfig_featureValidationInputDetails = untrustedConfig.featureValidationInputDetails;
+    if (ArrayIsArray$1(untrustedConfig_featureValidationInputDetails)) {
+        const untrustedConfig_featureValidationInputDetails_array = [];
+        for (let i = 0, arrayLength = untrustedConfig_featureValidationInputDetails.length; i < arrayLength; i++) {
+            const untrustedConfig_featureValidationInputDetails_item = untrustedConfig_featureValidationInputDetails[i];
+            if (untrustedIsObject(untrustedConfig_featureValidationInputDetails_item)) {
+                const untrustedConfig_featureValidationInputDetails_item_object = {};
+                if (untrustedConfig_featureValidationInputDetails_item_object !== undefined && Object.keys(untrustedConfig_featureValidationInputDetails_item_object).length >= 0) {
+                    untrustedConfig_featureValidationInputDetails_array.push(untrustedConfig_featureValidationInputDetails_item_object);
+                }
+            }
+        }
+        config.featureValidationInputDetails = untrustedConfig_featureValidationInputDetails_array;
+    }
+    const untrustedConfig_useCase = untrustedConfig.useCase;
+    if (typeof untrustedConfig_useCase === 'string') {
+        config.useCase = untrustedConfig_useCase;
+    }
+    return config;
+}
+function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => {
+            const snapshot = ingestSuccess(luvio, resourceParams, response);
+            return luvio.storeBroadcast().then(() => snapshot);
+        }, () => getResponseCacheKeys(luvio, resourceParams, response.body));
+    }, (response) => {
+        deepFreeze(response);
+        throw response;
+    });
+}
+const featureValidationAdapterFactory = (luvio) => {
+    return function featureValidation(untrustedConfig) {
+        const config = validateAdapterConfig(untrustedConfig, featureValidation_ConfigPropertyNames);
+        // Invalid or incomplete config
+        if (config === null) {
+            throw new Error('Invalid config for "featureValidation"');
+        }
+        return buildNetworkSnapshot(luvio, config);
+    };
+};
+
+let featureValidation;
+function bindExportsTo(luvio) {
+    function unwrapSnapshotData(factory) {
+        const adapter = factory(luvio);
+        return (config) => adapter(config).then(snapshot => snapshot.data);
+    }
+    return {
+        featureValidation: unwrapSnapshotData(featureValidationAdapterFactory),
+        // Imperative GET Adapters
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({
+        featureValidation,
+    } = bindExportsTo(luvio));
+});
+
+export { featureValidation };
+// version: 1.124.0-2cc971a9c

package/src/raml/api.raml

@@ -0,0 +1,127 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  FeatureValidationFieldValuesRepresentation:
+    description: Select fields that were validated as part of use-case implementation.
+    type: object
+    properties:
+      fieldName:
+        description: Field name
+        type: string
+      fieldValue:
+        description: Field value
+        type: string
+      message:
+        description: 'Message related to the field. Example: Missing fls permissions.'
+        type: string
+      required:
+        description: true if field is required. false otherwise.
+        type: boolean
+  FeatureValidationInputDetailsRepresentation:
+    description: |-
+      Holds BPO recordUsage and bpo recordId. example: {"recordUsage": "Facility",
+            "bpoRecordId": "0bSxx0000000005EAA"}
+    type: object
+    properties:
+      bpoRecordId:
+        description: Input BPO record id
+        type: string
+      recordUsage:
+        description: "How record is used in the feature. Example value: Patient. Note:
+          Account is a bpo name but Patient is a business usage of the patient's
+          account"
+        type: string
+  FeatureValidationInputRepresentation:
+    description: Feature validation input
+    type: object
+    properties:
+      featureValidationInputDetails:
+        description: Holds record usage and bpo recordId.
+        type: array
+        items:
+          type: object
+      useCase:
+        description: Use-case to validate the data. HealthCloudIAM needs user to pass
+          on practitioner id, facility id, patient id, and worktype id in featureValidationInputDetails.
+        type: string
+        enum:
+          - HealthCloudIAM
+  FeatureValidationOutputDetailsRepresentation:
+    description: Holds BPO name, bpoRecordId, select fields from the bpo and related
+      error message.
+    type: object
+    properties:
+      bpoName:
+        description: BPO name
+        type: string
+      bpoRecordId:
+        description: BPO record id
+        type: string
+      featureValidationFieldValues:
+        description: Select fields that were validated as part of use-case implementation.
+        type: array
+        items:
+          type: FeatureValidationFieldValuesRepresentation
+      message:
+        description: 'Message related to the bpo. Example: Invalid record Id.'
+        type: string
+  FeatureValidationOutputRepresentation:
+    description: FeatureValidation output.
+    type: object
+    properties:
+      errorMessage:
+        description: Get FeatureValidation error messages
+        type: string
+        required: false
+      featureValidationOutputDetails:
+        description: Holds BPO name, bpoRecordId, select fields from the bpo and related
+          error message.
+        type: array
+        items:
+          type: FeatureValidationOutputDetailsRepresentation
+      isSuccess:
+        description: Get FeatureValidation success flag
+        type: boolean
+/connect:
+  /industries:
+    /feature-validation:
+      post:
+        displayName: postFeatureValidation
+        description: |-
+          Run a feature validation to validate data setup for a given use-case and respective record Ids. Supported use cases are @ FeatureValidationUseCaseEnum.
+           To add new usecase, add your implementation to this post method and FeatureValidationUseCaseEnum. Populate FeatureValidationOutputRepresentation with the validated BPOs.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FeatureValidationOutputRepresentation
+        body:
+          application/json:
+            type: FeatureValidationInputRepresentation
+            # TODO [W-12609182]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+            (oas-body-name): FeatureValidationData

package/src/raml/luvio.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'featurevalidation'
+types:
+  FeatureValidationOutputRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+    (luvio.ttl): 300
+
+/connect/industries/feature-validation:
+  post:
+    (luvio.adapter):
+      name: featureValidation