@salesforce/lds-adapters-service-ecm 1.329.1 → 1.331.0

package/src/raml/api.raml

@@ -43,7 +43,7 @@ types:
           - NotEquals
       value:
         description: value
-        type: object
+        type: any
   ServiceAutomationDepOutputRepresentation:
     description: Output Representation of Record
     type: object
@@ -72,7 +72,7 @@ types:
         description: The filter to be applied while fetching records
         type: array
         items:
-          type: object
+          type: FilterInputRepresentation
       limit:
         description: The limit to be applied while fetching records
         type: integer | nil
@@ -87,218 +87,447 @@ types:
         properties:
           //:
             type: any
+  AssociatedArticleOutputRepresentation:
+    description: Output Representation for Associated Articles
+    type: object
+    properties:
+      id:
+        required: false
+        description: Id of the associated article
+        type: string | nil
+      knowledgeArticleId:
+        required: false
+        description: Knowledge Article Id of the associated article
+        type: string | nil
   CatalogItemAttributeInputRepresentation:
     description: Input Representation for Attribute Item.
     type: object
     properties:
       apiName:
+        required: false
         description: Attribute API Name
-        type: string
-      contextAttributeId:
-        description: Context Attribute Id
-        type: string
+        type: string | nil
       dataType:
+        required: false
         description: Attribute Data Type
-        type: string
+        type: string | nil
         enum:
+          - Boolean
           - Date
+          - DateTime
+          - Double
+          - List
+          - ListOfBoolean
+          - ListOfDouble
+          - ListOfInteger
+          - ListOfMaps
+          - ListOfString
+          - Lookup
+          - Map
           - Number
           - Picklist
           - Text
       defaultValue:
+        required: false
         description: Attribute Default Value
-        type: string
+        type: string | nil
       description:
+        required: false
         description: Attribute Description
-        type: string
+        type: string | nil
       id:
+        required: false
         description: Attribute Name
-        type: string
+        type: string | nil
+      isContextDefinitionAttribute:
+        required: false
+        description: Context Attribute Id
+        type: boolean | nil
       isHidden:
+        required: false
         description: is Hidden
-        type: boolean
+        type: boolean | nil
+      isReadOnly:
+        required: false
+        description: is Read Only
+        type: boolean | nil
       name:
+        required: false
         description: Attribute Name
-        type: string
+        type: string | nil
       operationType:
+        required: false
         description: The type of operation that attribute support.
-        type: string
+        type: string | nil
         enum:
           - Create
           - Delete
           - Update
       parent:
+        required: false
         description: Attribute Parent
-        type: string
+        type: string | nil
       sequence:
+        required: false
         description: Sequence Number
-        type: integer
+        type: integer | nil
   CatalogItemAttributeOutputRepresentation:
     description: Output representation class for the Attributes of Catalog Item
     type: object
     properties:
       apiName:
+        required: false
         description: Attribute Api Name
-        type: string
-      contextAttributeId:
-        description: Attribute Context Attribute Id
-        type: string
+        type: string | nil
       dataType:
+        required: false
         description: Attribute Data Type
-        type: string
+        type: string | nil
         enum:
+          - Boolean
           - Date
+          - DateTime
+          - Double
+          - List
+          - ListOfBoolean
+          - ListOfDouble
+          - ListOfInteger
+          - ListOfMaps
+          - ListOfString
+          - Lookup
+          - Map
           - Number
           - Picklist
           - Text
       defaultValue:
+        required: false
         description: Attribute Default Value
-        type: string
+        type: string | nil
       description:
+        required: false
         description: Attribute Description
-        type: string
+        type: string | nil
+      id:
+        required: false
+        description: Attribute Id
+        type: string | nil
+      isContextDefinitionAttribute:
+        required: false
+        description: Attribute Context Attribute Id
+        type: boolean | nil
+      isDeleted:
+        required: false
+        description: Attribute Is Deleted
+        type: boolean | nil
       isHidden:
+        required: false
         description: Attribute Is Hidden
-        type: boolean
+        type: boolean | nil
+      isReadOnly:
+        required: false
+        description: Attribute isReadOnly
+        type: boolean | nil
+      isRequired:
+        required: false
+        description: Attribute Is Required
+        type: boolean | nil
       name:
+        required: false
         description: Attribute Name
-        type: string
+        type: string |nil
       parent:
+        required: false
         description: Attribute Parent
-        type: string
+        type: string | nil
       sequence:
+        required: false
         description: Attribute Sequence
-        type: integer
+        type: integer | nil
   CatalogItemCreateInputRepresentation:
     description: Configuration of the Catalog Item.
     type: object
-    properties: {}
-  CatalogItemInputRepresentation:
-    description: Input Representation for Catalog Item.
-    type: object
     properties:
       associatedArticles:
+        required: false
         description: Knowledge Articles
         type: array
         items:
-          type: object
+          type: KnowledgeArticleInputRepresentation | nil
       attributes:
+        required: false
         description: Attribute List
         type: array
         items:
-          type: object
-      contextDefinitionId:
+          type: CatalogItemAttributeInputRepresentation | nil
+      contextDefinitionDevNameOrId:
+        required: false
         description: Context Definition Id
-        type: string
+        type: string | nil
       description:
+        required: false
         description: Description
-        type: string
+        type: string | nil
+      displayUrl:
+        required: false
+        description: Display Url
+        type: string | nil
       eligibilityRules:
+        required: false
         description: Eligibility Rules
         type: array
         items:
-          type: object
+          type: EligibilityRulesInputRepresentation | nil
       fulfillmentFlow:
+        required: false
         description: Fulfillment Flow
-        type: object
+        type: FulfillmentFlowInputRepresentation | nil
       intakeForm:
+        required: false
         description: Intake Form
-        type: object
+        type: IntakeFormInputRepresentation | nil
       integrations:
+        required: false
         description: Integrations
         type: array
         items:
-          type: object
+          type: IntegrationDefInputRepresentation | nil
       isActive:
+        required: false
         description: is Active
-        type: boolean
+        type: boolean | nil
       name:
+        required: false
         description: Name
-        type: string
+        type: string | nil
       preProcessors:
+        required: false
         description: Pre-Processor
         type: array
         items:
-          type: object
-      type:
-        description: Type
-        type: string
+          type: PreprocessorInputRepresentation | nil
+      usedFor:
+        required: false
+        description: UsedFor
+        type: string | nil
         enum:
-          - Product
-          - Service
+          - ServiceProcess
   CatalogItemOutputRepresentation:
     description: Output Representation of Catalog Item
     type: object
     properties:
       associatedArticles:
+        required: false
         description: Knowledge Articles
         type: array
         items:
-          type: string
-      attributes:
+          type: AssociatedArticleOutputRepresentation | nil
+      section:
+        required: false
         description: Attributes
-        type: array
-        items:
-          type: CatalogItemAttributeOutputRepresentation
+        type: SectionOutputRepresentation | nil
       catalogItemId:
+        required: true
         description: Id of the Catalog Item
-        type: string
-      contextDefinitionId:
+        type: string | nil
+      contextDefinitionDevNameOrId:
+        required: false
         description: Context Definition Id
-        type: string
+        type: string | nil
       description:
+        required: false
         description: Description of the Catalog Item
-        type: string
+        type: string | nil
+      displayUrl:
+        required: false
+        description: Display Url
+        type: string | nil
       eligibilityRules:
+        required: false
         description: Eligibility Rules
         type: array
         items:
-          type: string
+          type: EligibilityRuleOutputRepresentation | nil
       fulfillmentFlow:
+        required: false
         description: Fulfillment Flows
-        type: FulfillmentFlowOutputRepresentation
+        type: FulfillmentFlowOutputRepresentation | nil
       intakeForm:
+        required: false
         description: Intake Form
-        type: IntakeFormOutputRepresentation
+        type: IntakeFormOutputRepresentation | nil
       integrations:
+        required: false
         description: Integrations
         type: array
         items:
-          type: string
+          type: IntegrationDefinitionOutputPresentation | nil
       isActive:
+        required: false
         description: is Active
-        type: boolean
+        type: boolean | nil
       name:
+        required: false
         description: Name of the Catalog Item
-        type: string
+        type: string | nil
+      productId:
+        required: false
+        description: Product Id
+        type: string | nil
       preProcessors:
+        required: false
         description: Pre Processor Ids
         type: array
         items:
-          type: string
-      type:
-        description: Type of the Catalog Item
-        type: string
+          type: PreprocessorOutputRepresentation | nil
+      usedFor:
+        required: false
+        description: usedFor of the Catalog Item
+        type: string | nil
         enum:
-          - Product
-          - Service
+          - ServiceProcess
   CatalogItemUpdateInputRepresentation:
     description: The configuration of updates to the CatalogItem
     type: object
     properties:
+      productId:
+        required: false
+        description: The ID of the catalog Item
+        type: string | nil
+      associatedArticles:
+        required: false
+        description: Knowledge Articles
+        type: array
+        items:
+          type: KnowledgeArticleInputRepresentation | nil
+      attributes:
+        required: false
+        description: Attribute List
+        type: array
+        items:
+          type: CatalogItemAttributeInputRepresentation | nil
+      contextDefinitionDevNameOrId:
+        required: false
+        description: Context Definition Id
+        type: string | nil
+      description:
+        required: false
+        description: Description
+        type: string | nil
+      displayUrl:
+        required: false
+        description: Display Url
+        type: string | nil
+      eligibilityRules:
+        required: false
+        description: Eligibility Rules
+        type: array
+        items:
+          type: EligibilityRulesInputRepresentation | nil
+      fulfillmentFlow:
+        required: false
+        description: Fulfillment Flow
+        type: FulfillmentFlowInputRepresentation | nil
+      intakeForm:
+        required: false
+        description: Intake Form
+        type: IntakeFormInputRepresentation | nil
+      integrations:
+        required: false
+        description: Integrations
+        type: array
+        items:
+          type: IntegrationDefInputRepresentation | nil
+      isActive:
+        required: false
+        description: is Active
+        type: boolean | nil
+      name:
+        required: false
+        description: Name
+        type: string | nil
+      preProcessors:
+        required: false
+        description: Pre-Processor
+        type: array
+        items:
+          type: PreprocessorInputRepresentation | nil
+      usedFor:
+        required: false
+        description: UsedFor
+        type: string | nil
+        enum:
+          - ServiceProcess
+  EligibilityRuleOutputRepresentation:
+    description: Output Representation for Eligibility Rules
+    type: object
+    properties:
+      eligibilityRuleId:
+        required: false
+        description: Eligibility Rule Id
+        type: string | nil
       id:
+        required: false
+        description: Id
+        type: string | nil
+  EligibilityRulesInputRepresentation:
+    description: Input Representation for Eligibility Rules
+    type: object
+    properties:
+      id:
+        required: false
         description: The ID of the catalog Item
-        type: string
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+  FulfillmentFlowOutputRepresentation:
+    description: Output Representation for Fulfillment Flow
+    type: object
+    properties:
+      fulFillmentFlowId:
+        required: false
+        description: FulfillmentFlow Id
+        type: string | nil
+      id:
+        required: false
+        description: ProductFulfillmentScenario Id
+        type: string | nil
+      type:
+        required: false
+        description: FulfillmentFlow Type
+        type: string | nil
+        enum:
+          - Flow
+          - FlowOrchestrator
   IntakeFormInputRepresentation:
     description: Input Representation for Intake Forms.
     type: object
     properties:
       id:
+        required: false
         description: The ID of the catalog Item
-        type: string
+        type: string | nil
+      intakeFormId:
+        required: false
+        description: The intake form ID
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
       type:
+        required: false
         description: The Type of the catalog Item
-        type: string
+        type: string | nil
         enum:
           - Flow
           - Omniscript
@@ -307,67 +536,158 @@ types:
     type: object
     properties:
       id:
+        required: false
+        description: Id
+        type: string | nil
+      intakeFormId:
+        required: false
         description: Intake Form Id
-        type: string
+        type: string | nil
+      omniProcessId:
+        required: false
+        description: OmniProcess Id
+        type: string | nil
+      omniScriptLanguage:
+        required: false
+        description: OmniScript Language
+        type: string | nil
+      omniScriptSubType:
+        required: false
+        description: OmniScript SubType
+        type: string | nil
+      omniScriptType:
+        required: false
+        description: OmniScript Type
+        type: string | nil
       type:
+        required: false
         description: Intake Form Type
-        type: string
+        type: string | nil
         enum:
           - Flow
           - Omniscript
-  CatalogItemCreateWrapperInputRepresentation:
-    description: Wrapper class for catalog item create input representation.
+      uniqueName:
+        required: false
+        description: Unique Name
+        type: string | nil
+  IntegrationDefInputRepresentation:
+    description: Input Representation for Integration Definition.
     type: object
     properties:
-      catalogItemCreateInput:
-        description: Input Representation for Catalog Item Create
-        type: CatalogItemCreateInputRepresentation
-  CatalogItemUpdateWrapperInputRepresentation:
-    description: Wrapper class for catalog item update input representation.
+      id:
+        required: false
+        description: The ID of the catalog Item
+        type: string | nil
+      integrationDefinitionId:
+        required: false
+        description: The ID of the catalog Item
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+  IntegrationDefinitionOutputPresentation:
+    description: Output Representation for Integration Definition
+    type: object
+    properties:
+      id:
+        required: false
+        description: Id of the Integration Definition
+        type: string | nil
+      integrationDefId:
+        required: false
+        description: Integration Definition Id
+        type: string | nil
+  KnowledgeArticleInputRepresentation:
+    description: Input Representation for Knowledge Articles.
     type: object
     properties:
-      catalogItemUpdateInput:
-        description: Input Representation for Catalog Item Update
-        type: CatalogItemUpdateInputRepresentation
+      id:
+        required: false
+        description: The ID of the catalog Item
+        type: string | nil
+      knowledgeArticleId:
+        required: false
+        description: The ID of KnowledgeArticle
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
   PreprocessorInputRepresentation:
     description: Input Representation for Preprocessor
     type: object
     properties:
       id:
+        required: false
         description: The ID of the catalog Item
-        type: string
+        type: string | nil
       operationType:
+        required: false
         description: The operation type of the catalog Item
-        type: string
+        type: string | nil
         enum:
           - Create
           - Delete
-  FulfillmentFlowOutputRepresentation:
-    description: Output Representation for Fulfillment Flow
+          - Update
+      preProcessorsID:
+        required: false
+        description: The ID of Preprocessor
+        type: string | nil
+  PreprocessorOutputRepresentation:
+    description: Output Representation for Preprocessors
     type: object
     properties:
       id:
-        description: FulfillmentFlow Id
-        type: string
-      type:
-        description: FulfillmentFlow Type
-        type: string
-        enum:
-          - Flow
-          - FlowOrchestrator
-  FulfillmentFowInputRepresentation:
+        required: false
+        description: ProductConfigFlow Id
+        type: string | nil
+      preprocessorId:
+        required: false
+        description: Preprocessor Id
+        type: string | nil
+  FulfillmentFlowInputRepresentation:
     description: Input Representation for Fulfillment Flow
     type: object
     properties:
+      fulfillmentFlowId:
+        required: false
+        description: The ID of FulfillmentFlow
+        type: string | nil
       id:
+        required: false
         description: The ID of the catalog Item
-        type: string
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
       type:
+        required: false
         description: The Type of the catalog Item
-        type: string
+        type: string | nil
         enum:
           - Flow
           - FlowOrchestrator
+  GenericCustomObject:
+    description: GenericCustomObject
+    type: object
+    properties:
+      value:
+        description: value
+        type: object
   CategoriesInputRepresentation:
     description: Category and Parent api input representation
     type: object
@@ -415,80 +735,156 @@ types:
       status:
         description: Output status code
         type: string
-
+  OmniIntakeOutputRepresentation:
+    description: Output Representation of Catalog Item
+    type: object
+    properties:
+      description:
+        description: Intake Form Description
+        type: string
+      id:
+        description: Intake Form Id
+        type: string
+      name:
+        description: Intake Form Name
+        type: string
+      omniScriptId:
+        description: OmniScript Id
+        type: string
+      omniScriptLanguage:
+        description: OmniScript Language
+        type: string
+      omniScriptSubType:
+        description: OmniScript SubType
+        type: string
+      omniScriptType:
+        description: OmniScript Type
+        type: string
+      type:
+        description: Intake Form Type
+        type: string
+        enum:
+          - Flow
+          - Omniscript
+  IntakeFormCreationInputRepresentation:
+    description: 'CatalogItem OmniScript Intake Input Representation '
+    type: object
+    properties:
+      productId:
+        description: Product Id
+        type: string
+      scriptDescription:
+        description: Omni Script Description
+        type: string
+      scriptName:
+        description: Omni Script Name
+        type: string
+  SectionOutputRepresentation:
+    description: Output Representation for Section
+    type: object
+    properties:
+      name:
+        required: false
+        description: Product Name
+        type: string | nil
+      description:
+        required: false
+        description: Product Name
+        type: string | nil
+      attributes:
+        required: false
+        description: Attribute List
+        type: array
+        items:
+          type: CatalogItemAttributeOutputRepresentation | nil
 /connect:
-  /catalog/catalog-item:
+  /catalog:
+    /catalog-item:
+      post:
+        displayName: postCatalogItemSave
+        description: API to create a catalog item record.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CatalogItemOutputRepresentation
+        body:
+          application/json:
+            type: CatalogItemCreateInputRepresentation
+            (oas-body-name): catalogItemCreateInput
+    /catalog-item/{catalogItemId}:
+      get:
+        displayName: getCatalogItemGet
+        description: API to fetch catalog record based on catalog id.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CatalogItemOutputRepresentation
+      patch:
+        displayName: patchCatalogItemGet
+        description: Patches Catalog Item with Given Catalog item id.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CatalogItemOutputRepresentation
+        body:
+          application/json:
+            type: CatalogItemUpdateInputRepresentation
+            (oas-body-name): catalogItemUpdateInput
+      uriParameters:
+        catalogItemId:
+          description: CatalogId for which catalog details have to be fetched.
+          type: string
+          required: true
+    /{catalogId}/categories:
+      patch:
+        displayName: patchCategories
+        description: API to update categories of a specified catalog.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CategoryAndParentOutputRepresentation
+        body:
+          application/json:
+            type: CategoriesInputRepresentation
+            (oas-body-name): epcCategoryParentRequestPayload
+      uriParameters:
+        catalogId:
+          description: CatalogId for which categories are realigned.
+          type: string
+          required: true
+  /service-automation:
     post:
-      displayName: postCatalogItemSave
-      description: API to create a catalog item record.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: CatalogItemOutputRepresentation
-      body:
-        application/json:
-          type: CatalogItemCreateWrapperInputRepresentation
-          (oas-body-name): catalogItemCreateInput
-  /catalog/catalog-item/{catalogItemId}:
-    get:
-      displayName: getCatalogItemGet
-      description: API to fetch catalog record based on catalog id.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: CatalogItemOutputRepresentation
-    patch:
-      displayName: patchCatalogItemGet
-      description: Patches Catalog Item with Given Catalog item id.
-      responses:
-        '200':
-          description: Success
-          body:
-            application/json:
-              type: CatalogItemOutputRepresentation
-      body:
-        application/json:
-          type: CatalogItemUpdateWrapperInputRepresentation
-          (oas-body-name): catalogItemUpdateInput
-    uriParameters:
-      catalogItemId:
-        description: CatalogId for which catalog details have to be fetched.
-        type: string
-        required: true
-  /catalog/{catalogId}/categories:
-    patch:
-      displayName: patchCategories
-      description: API to update categories of a specified catalog.
+      displayName: postServiceAutomation
+      description: POST Resource method to obtain Specified Class objects
       responses:
         '200':
           description: Success
           body:
             application/json:
-              type: CategoryAndParentOutputRepresentation
+              type: ServiceAutomationDepOutputRepresentation
       body:
         application/json:
-          type: CategoriesInputRepresentation
-          (oas-body-name): epcCategoryParentRequestPayload
-    uriParameters:
-      catalogId:
-        description: CatalogId for which categories are realigned.
-        type: string
-        required: true
-  /service-automation:
+          type: ServiceAutomationDepReadInputRepresentation
+          (oas-body-name): ServiceAutomationDepInput
+  /service-automation/generate-intake-omni:
     post:
-      displayName: postServiceAutomation
-      description: POST Resource method to obtain Specified Class objects
+      displayName: postOmniIntake
+      description: API to generate omniscript for productId.
       responses:
         '200':
           description: Success
           body:
             application/json:
-              type: ServiceAutomationDepOutputRepresentation
+              type: OmniIntakeOutputRepresentation
       body:
         application/json:
-          type: ServiceAutomationDepReadInputRepresentation
-          (oas-body-name): ServiceAutomationDepInput
+          type: IntakeFormCreationInputRepresentation
+          (oas-body-name): omniGenerateRequestPayload