@salesforce/lds-adapters-service-ecm 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1712 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  FilterInputRepresentation:
+    description: The query Filter input representation.
+    type: object
+    properties:
+      field:
+        description: field
+        type: string
+      operator:
+        description: operator
+        type: string
+        enum:
+          - Equals
+          - GreaterThan
+          - LessThan
+          - Like
+          - NotEquals
+      value:
+        description: value
+        type: any
+  ServiceAutomationDepOutputRepresentation:
+    description: Output Representation of Record
+    type: object
+    properties:
+      entityApiName:
+        description: Name of the entity
+        type: string
+      records:
+        description: List of records to be returned for the given entityApiName
+        type: array
+        items:
+          type: ServiceAutomationOutputRecordRepresentation
+  ServiceAutomationDepReadInputRepresentation:
+    description: 'Representation of the ServiceAutomation Input Request '
+    type: object
+    properties:
+      entityName:
+        description: The name of the entity records to be fetched
+        type: string
+      fields:
+        description: The fields to be fetched for the entity
+        type: array
+        items:
+          type: string
+      filters:
+        description: The filter to be applied while fetching records
+        type: array
+        items:
+          type: FilterInputRepresentation
+      limit:
+        description: The limit to be applied while fetching records
+        type: integer | nil
+        required: false
+  ServiceAutomationOutputRecordRepresentation:
+    description: Output Representation of Service Automation Record List
+    type: object
+    properties:
+      fields:
+        description: Fields Map of the record.
+        type: object
+        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 | nil
+      dataType:
+        required: false
+        description: Attribute Data Type
+        type: string | nil
+        enum:
+          - Boolean
+          - CheckBox
+          - Currency
+          - Date
+          - Datetime
+          - Double
+          - List
+          - ListOfBoolean
+          - ListOfDouble
+          - ListOfInteger
+          - ListOfMaps
+          - ListOfString
+          - Lookup
+          - Map
+          - Number
+          - Percentage
+          - Picklist
+          - Text
+          - Attachment
+      defaultValue:
+        required: false
+        description: Attribute Default Value
+        type: string | nil
+      description:
+        required: false
+        description: Attribute Description
+        type: string | nil
+      id:
+        required: false
+        description: Attribute Name
+        type: string | nil
+      isContextDefinitionAttribute:
+        required: false
+        description: Context Attribute Id
+        type: boolean | nil
+      isEditable:
+        required: false
+        description: Is Editable Field
+        type: boolean
+      isHidden:
+        required: false
+        description: is Hidden
+        type: boolean | nil
+      isMandatory:
+        required: false
+        description: is Mandatory
+        type: boolean | nil
+      isMappedAnchorField:
+        required: false
+        description: is Mapped Anchor Field
+        type: boolean
+      isReadOnly:
+        required: false
+        description: is Read Only
+        type: boolean | nil
+      name:
+        required: false
+        description: Attribute Name
+        type: string | nil
+      operationType:
+        required: false
+        description: The type of operation that attribute support.
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      parent:
+        required: false
+        description: Attribute Parent
+        type: string | nil
+      picklistOptions:
+        required: false
+        description: Picklist Options
+        type: array
+        items:
+          type: PicklistAttributeTypeInputRepresentation | nil
+      sequence:
+        required: false
+        description: Sequence Number
+        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 | nil
+      dataType:
+        required: false
+        description: Attribute Data Type
+        type: string | nil
+        enum:
+          - Boolean
+          - CheckBox
+          - Currency
+          - Date
+          - Datetime
+          - Double
+          - List
+          - ListOfBoolean
+          - ListOfDouble
+          - ListOfInteger
+          - ListOfMaps
+          - ListOfString
+          - Lookup
+          - Map
+          - Number
+          - Percentage
+          - Picklist
+          - Text
+          - Attachment
+      defaultValue:
+        required: false
+        description: Attribute Default Value
+        type: string | nil
+      description:
+        required: false
+        description: Attribute Description
+        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
+      isEditable:
+        required: false
+        description: Is Editable Field
+        type: boolean
+      isHidden:
+        required: false
+        description: Attribute Is Hidden
+        type: boolean | nil
+      isMandatory:
+        required: false
+        description: is Mandatory
+        type: boolean | nil
+      isMappedAnchorField:
+        required: false
+        description: Mapped Anchor Field
+        type: boolean
+      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 |nil
+      parent:
+        required: false
+        description: Attribute Parent
+        type: string | nil
+      picklistOptions:
+        required: false
+        description: Picklist Options
+        type: array
+        items:
+          type: PicklistAttributeTypeOutputRepresentation | nil
+      sequence:
+        required: false
+        description: Attribute Sequence
+        type: integer | nil
+  CatalogItemCreateInputRepresentation:
+    description: Configuration of the Catalog Item.
+    type: object
+    properties:
+      agentAction:
+        required: false
+        description: Agent Action for the Catalog Item
+        type: AgentActionInputRepresentation | 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
+      sections:
+        required: false
+        description: Section List
+        type: array
+        items:
+          type: SectionInputRepresentation | 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
+      productRequests:
+        required: false
+        description: ProductRequests
+        type: array
+        items:
+          type: ProductRequestCreateInputRepresentation | nil
+      targetObject:
+        description: TargetObject
+        type: string | nil
+        enum:
+          - Case
+          - Incident
+      usedFor:
+        required: false
+        description: UsedFor
+        type: string | nil
+        enum:
+          - ServiceProcess
+  CatalogItemOutputRepresentation:
+    description: Output Representation of Catalog Item
+    type: object
+    properties:
+      agentAction:
+        required: false
+        description: Agent Action
+        type: AgentActionOutputRepresentation | nil
+      associatedArticles:
+        required: false
+        description: Knowledge Articles
+        type: array
+        items:
+          type: AssociatedArticleOutputRepresentation | nil
+      section:
+        required: false
+        description: Section
+        type: SectionOutputRepresentation | nil
+      sections:
+        required: false
+        description: Sections
+        type: array
+        items:
+          type: SectionOutputRepresentation | nil
+      catalogItemId:
+        required: true
+        description: Id of the Catalog Item
+        type: string | nil
+      contextDefinitionDevNameOrId:
+        required: false
+        description: Context Definition Id
+        type: string | nil
+      description:
+        required: false
+        description: Description of the Catalog Item
+        type: string | nil
+      displayUrl:
+        required: false
+        description: Display Url
+        type: string | nil
+      eligibilityRules:
+        required: false
+        description: Eligibility Rules
+        type: array
+        items:
+          type: EligibilityRuleOutputRepresentation | nil
+      fulfillmentFlow:
+        required: false
+        description: Fulfillment Flows
+        type: FulfillmentFlowOutputRepresentation | nil
+      intakeForm:
+        required: false
+        description: Intake Form
+        type: IntakeFormOutputRepresentation | nil
+      integrations:
+        required: false
+        description: Integrations
+        type: array
+        items:
+          type: IntegrationDefinitionOutputPresentation | nil
+      isActive:
+        required: false
+        description: is Active
+        type: boolean | nil
+      name:
+        required: false
+        description: Name of the Catalog Item
+        type: string | nil
+      productId:
+        required: false
+        description: Product Id
+        type: string | nil
+      preProcessors:
+        required: false
+        description: Pre Processor Ids
+        type: array
+        items:
+          type: PreprocessorOutputRepresentation | nil
+      productRequests:
+        required: false
+        description: ProductRequests
+        type: array
+        items:
+          type: ProductRequestOutputRepresentation | nil
+      targetObject:
+        required: false
+        description: Target Object
+        type: string | nil
+        enum:
+          - Case
+          - Incident
+      usedFor:
+        required: false
+        description: usedFor of the Catalog Item
+        type: string | nil
+        enum:
+          - ServiceProcess
+  CatalogItemUpdateInputRepresentation:
+    description: The configuration of updates to the CatalogItem
+    type: object
+    properties:
+      agentAction:
+        required: false
+        description: Agent Action for the Catalog Item
+        type: AgentActionInputRepresentation | nil
+      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
+      sections:
+        required: false
+        description: Section List
+        type: array
+        items:
+          type: SectionInputRepresentation | 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
+      productRequests:
+        required: false
+        description: ProductRequests
+        type: array
+        items:
+          type: ProductRequestCreateInputRepresentation | nil
+      targetObject:
+        required: false
+        description: Target Object
+        type: string | nil
+        enum:
+          - Case
+          - Incident
+      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 | 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 | 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 | nil
+        enum:
+          - Flow
+          - Omniscript
+  IntakeFormOutputRepresentation:
+    description: Output Representation for Intake Forms
+    type: object
+    properties:
+      id:
+        required: false
+        description: Id
+        type: string | nil
+      intakeFormId:
+        required: false
+        description: Intake Form Id
+        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 | nil
+        enum:
+          - Flow
+          - Omniscript
+      uniqueName:
+        required: false
+        description: Unique Name
+        type: string | nil
+  GenerateIntakeFormInputRepresentation:
+    description: 'Intake form Input Representation '
+    type: object
+    properties:
+      description:
+        required: false
+        description: Intake Form Description
+        type: string
+      name:
+        required: false
+        description: Intake Form Name
+        type: string
+      productId:
+        required: false
+        description: Product Id
+        type: string
+      type:
+        required: false
+        description: Intake Form Type
+        type: string
+        enum:
+          - Flow
+          - Omniscript
+  GenerateIntakeFormOutputRepresentation:
+    description: Output Representation of Generate Intake Form
+    type: object
+    properties:
+      description:
+        required: false
+        description: Intake Form Description
+        type: string
+      id:
+        description: Intake Form Id
+        type: string
+      name:
+        required: false
+        description: Intake Form Name
+        type: string
+      type:
+        required: false
+        description: Intake Form Type
+        type: string
+        enum:
+          - Flow
+          - Omniscript
+  IntegrationDefInputRepresentation:
+    description: Input Representation for Integration Definition.
+    type: object
+    properties:
+      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
+      integrationDefinitionId:
+        required: false
+        description: Integration Definition Id
+        type: string | nil
+  KnowledgeArticleInputRepresentation:
+    description: Input Representation for Knowledge Articles.
+    type: object
+    properties:
+      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
+  PicklistAttributeTypeInputRepresentation:
+    description: Picklist Attribute Type
+    type: object
+    properties:
+      displayName:
+        required: false
+        description: Picklist Display Name
+        type: string
+      id:
+        required: false
+        description: Picklist Id
+        type: string
+      isDefault:
+        required: false
+        description: Picklist Is Default
+        type: boolean
+      isVisible:
+        required: false
+        description: Picklist Is Visible
+        type: boolean
+      name:
+        required: false
+        description: Picklist Name
+        type: string
+      sequenceNumber:
+        required: false
+        description: Picklist Sequence Number
+        type: integer
+      operationType:
+        required: false
+        description: The operation type of the picklist option
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+  PicklistAttributeTypeOutputRepresentation:
+    description: Output representation class for the Picklist Attribute Type
+    type: object
+    properties:
+      displayName:
+        required: false
+        description: Picklist Option Display Name
+        type: string
+      id:
+        required: false
+        description: Picklist Option Id
+        type: string
+      isDefault:
+        required: false
+        description: Picklist Option isDefault
+        type: boolean
+      isVisible:
+        required: false
+        description: Picklist Option isVisible
+        type: boolean
+      name:
+        required: false
+        description: Picklist Option Name
+        type: string
+      sequenceNumber:
+        required: false
+        description: Picklist Option Sequence Number
+        type: integer
+  PreprocessorInputRepresentation:
+    description: Input Representation for Preprocessor
+    type: object
+    properties:
+      id:
+        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
+      preProcessorsID:
+        required: false
+        description: The ID of Preprocessor
+        type: string | nil
+  PreprocessorOutputRepresentation:
+    description: Output Representation for Preprocessors
+    type: object
+    properties:
+      id:
+        required: false
+        description: ProductConfigFlow Id
+        type: string | nil
+      preProcessorsID:
+        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 | 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 | 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
+    properties:
+      categories:
+        description: List of Category ID and Parent ID
+        type: array
+        #TODO: Hand-rolled
+        items:
+          type: CategoryInput
+  CategoryInput:
+    description: Category and Parent api input payload representation
+    type: object
+    properties:
+      categoryId:
+        description: Specifies Category ID
+        type: string
+      parentCategoryId:
+        description: Specifies Parent Category ID
+        type: string
+  CategoryAndParentErrorOutputRepresentation:
+    description: 'Output representation for errors during update of Categories '
+    type: object
+    properties:
+      errorMessageList:
+        description: Error list during the update of categories
+        type: array
+        items:
+          type: string
+  CategoryAndParentOutputRepresentation:
+    description: Category And Parent
+    type: object
+    properties:
+      catalogId:
+        description: Catalog ID
+        type: string
+      errors:
+        description: Error list for categories realignment
+        type: array
+        items:
+          type: CategoryAndParentErrorOutputRepresentation
+      message:
+        description: Output message
+        type: string
+      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
+  ProductDetailsInputRepresentation:
+    description: Input Representation for Product Details.
+    type: object
+    properties:
+      id:
+        required: false
+        description: The id of the parent product
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the catalog Item
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      productId:
+        required: false
+        description: The id of the product
+        type: string | nil
+  ProductDetailsOutputRepresentation:
+    description: Output Representation for Product Details
+    type: object
+    properties:
+      id:
+        required: false
+        description: The id of the product request
+        type: string | nil
+      productId:
+        required: false
+        description: The id of the product
+        type: string | nil
+      productName:
+        required: false
+        description: Name of the product
+        type: string | nil
+      description:
+        required: false
+        description: Description of the product
+        type: string | nil
+      displayUrl:
+        required: false
+        description: displayUrl of the product
+        type: string | nil
+      productPrice:
+        required: false
+        description: 'Unit Price of the product'
+        type: string | nil
+  ProductRequestCreateInputRepresentation:
+    description: Input Representation for Product Request.
+    type: object
+    properties:
+      operationType:
+        required: false
+        description: Operation Type of the product request section
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      productDetails:
+        required: false
+        description: Product Details
+        type: array
+        items:
+          type: any
+      sectionDescription:
+        required: false
+        description: Section Description
+        type: string | nil
+      sectionMaxCount:
+        required: false
+        description: Section max count
+        type: integer | nil
+      sectionMinCount:
+        required: false
+        description: Section min count
+        type: integer | nil
+      sectionName:
+        required: false
+        description: Section Name
+        type: string | nil
+      sequence:
+        required: false
+        description: Sequence
+        type: integer | nil
+  ProductRequestOutputRepresentation:
+    description: Output Representation for Product Request
+    type: object
+    properties:
+      productDetails:
+        required: false
+        description: Product Details
+        type: array
+        items:
+          type: ProductDetailsOutputRepresentation
+      sectionDescription:
+        required: false
+        description: Section Description
+        type: string | nil
+      sectionId:
+        required: false
+        description: Section Id
+        type: string | nil
+      sectionMaxCount:
+        required: false
+        description: Section max count
+        type: integer | nil
+      sectionMinCount:
+        required: false
+        description: Section min count
+        type: integer | nil
+      sectionName:
+        required: false
+        description: Section Name
+        type: string | nil
+      sequence:
+        required: false
+        description: Sequence
+        type: integer | nil
+  ProductRequestUpdateInputRepresentation:
+    description: Input Representation for Product Request.
+    type: object
+    properties:
+      operationType:
+        required: false
+        description: Operation Type of the product request section
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      productDetails:
+        required: false
+        description: Product Details
+        type: array
+        items:
+          type: any
+      sectionDescription:
+        required: false
+        description: Section Description
+        type: string | nil
+      sectionId:
+        required: false
+        description: Section Id
+        type: string | nil
+      sectionMaxCount:
+        required: false
+        description: Section max count
+        type: integer | nil
+      sectionMinCount:
+        required: false
+        description: Section min count
+        type: integer | nil
+      sectionName:
+        required: false
+        description: Section Name
+        type: string | nil
+      sequence:
+        required: false
+        description: Section Sequence
+        type: integer | nil
+  SectionInputRepresentation:
+    description: Input Representation for Sections
+    type: object
+    properties:
+      attributes:
+        required: false
+        description: Attributes associated with Section
+        type: array
+        items:
+          type: any
+      description:
+        required: false
+        description: The Description of Section
+        type: string | nil
+      id:
+        required: false
+        description: The ID of Section
+        type: string | nil
+      name:
+        required: false
+        description: The Name of Section
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type of the section
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      sequence:
+        required: false
+        description: The sequence of Section
+        type: integer
+  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
+      id:
+        required: false
+        description: Id of the Section
+        type: string | nil
+      sequence:
+        required: false
+        description: The sequence of Section
+        type: integer
+  AgentActionInputRepresentation:
+    description: Input Representation for Agent Action
+    type: object
+    properties:
+      agentActionId:
+        required: false
+        description: The ID of the Agent Action
+        type: string | nil
+      id:
+        required: false
+        description: The ID of the Product Configuration Flow associated
+        type: string | nil
+      operationType:
+        required: false
+        description: The operation type for the updation or addition
+        type: string | nil
+        enum:
+          - Create
+          - Delete
+          - Update
+      status:
+        required: false
+        description: The Agent Action status for the service process
+        type: string | nil
+        enum:
+          - Active
+          - Draft
+          - Inactive
+  AgentActionOutputRepresentation:
+    description: Output Representation for Agent Action
+    type: object
+    properties:
+      agentActionId:
+        required: false
+        description: Agent Action Id
+        type: string | nil
+      id:
+        required: false
+        description: Product Configuration Flow Id
+        type: string | nil
+      status:
+        required: false
+        description: Status for the Agent Action
+        type: string | nil
+        enum:
+          - Active
+          - Draft
+          - Inactive
+  AgentAutolaunchedFlowInputRepresentation:
+    description: Input Representation of an Autolaunched Flow
+    type: object
+    properties:
+      description:
+        description: Description of the autolaunched flow.
+        type: string
+      developerName:
+        description: The unique developer name of the autolaunched flow.
+        type: string
+      label:
+        description: Display name for the autolaunched flow.
+        type: string
+      serviceProcessId:
+        description: The unique identifier of the service process for which autolaunched flow is getting created.
+        type: string
+  AgentAutolaunchedFlowRepresentation:
+    description: Output Representation of an Autolaunched Flow
+    type: object
+    properties:
+      flowDefinitionId:
+        description: The unique identifier of the flow definition.
+        type: string | nil
+      flowLatestVersionId:
+        description: The unique identifier of the latest version of the autolaunched flow
+        type: string | nil
+      isActive:
+        description: Indicates whether the flow is active (true) or not (false)
+        type: boolean | nil
+      status:
+        description: The success message or the error message with an error code that's displayed when creating the flow.
+        type: AgentAutolaunchedFlowStatusRepresentation
+  AgentAutolaunchedFlowStatusRepresentation:
+    description: Output Representation of the Flow Status
+    type: object
+    properties:
+      code:
+        description: The error code thrown when the request fails.
+        type: integer
+      message:
+        description: Message stating the reason for error, if any.
+        type: string
+  ServiceProcessTemplateOutputRepresentation:
+    description: Output Representation of Service Process Template
+    type: object
+    properties:
+      createdDate:
+        description: Template created date
+        type: string
+      description:
+        description: Template description
+        type: string
+      id:
+        description: Template Id
+        type: string
+      imageUrl:
+        description: Template image url
+        type: string
+      name:
+        description: Template name
+        type: string
+      type:
+        description: Template type
+        type: string
+  ServiceProcessTemplatesOutputRepresentation:
+    description: Output Representation of Service Process Templates
+    type: object
+    properties:
+      serviceProcessTemplateOutputRepresentation:
+        description: Service Process Template List
+        type: array
+        items:
+          type: ServiceProcessTemplateOutputRepresentation
+  ServiceRequestGetOutputRepresentation:
+    description: Service Request Get Output Representation
+    type: object
+    properties:
+      anchor:
+        required: false
+        description: Anchor object list
+        type: object
+        properties:
+          //:
+            type: any
+      customAttributes:
+        required: false
+        description: Custom Attributes list
+        type: object
+        properties:
+          //:
+            type: any
+      productAttributes:
+        required: false
+        description: Product object list
+        type: object
+        properties:
+          //:
+            type: any
+  AgentActionAttributeOutputRepresentation:
+    description: Output representation for an Agent Action Attribute
+    type: object
+    properties:
+      dataType:
+        description: Data type of the attribute
+        type: string
+      description:
+        description: Description of the Attribute
+        type: string
+      developerName:
+        description: Developer Name of the Atribute
+        type: string
+      displayable:
+        required: false
+        description: Is displayable
+        type: boolean
+      excludedFromPlanner:
+        required: false
+        description: Exclude from Planner
+        type: boolean
+      isPersIdentInfo:
+        required: false
+        description: Is PII Information
+        type: boolean
+      itemsDataType:
+        required: false
+        description: Data type of the items in the list
+        type: string
+      label:
+        description: Label of the Attribute
+        type: string
+      mappingType:
+        description: Mapping Type
+        type: string
+      maxItems:
+        required: false
+        description: Max items
+        type: integer
+      required:
+        required: false
+        description: Is Required Attribute
+        type: boolean
+      title:
+        description: Title of the Attribute
+        type: string
+      userInput:
+        required: false
+        description: Is user input
+        type: boolean
+  EinsteinAgentActionOutputRepresentation:
+    description: Output representation for an Agent Action
+    type: object
+    properties:
+      attributes:
+        description: Attributes of the Agent Action
+        type: array
+        items:
+          type: AgentActionAttributeOutputRepresentation
+      description:
+        description: 'Description of the Agent Action '
+        type: string
+      developerName:
+        description: 'Developer Name of the Agent Action '
+        type: string
+      id:
+        description: 'Identifier of the Agent Action '
+        type: string
+      includeInProgressIndicator:
+        required: false
+        description: Include progress indicator message
+        type: boolean
+      invocationTarget:
+        required: false
+        description: Invocation Target of the Agent Action
+        type: string
+      invocationTargetId:
+        required: false
+        description: Invocation Target ID of the Agent Action
+        type: string
+      invocationTargetType:
+        description: Invocation Target Type of the Agent Action
+        type: string
+      label:
+        description: 'Master Label of the Agent Action '
+        type: string
+      namespace:
+        required: false
+        description: Namespace of the Agent Action
+        type: string
+      progressIndicatorMessage:
+        required: false
+        description: Progress indicator message
+        type: string
+      userConfirmationRequired:
+        required: false
+        description: Is user confirmation required for executing Action
+        type: boolean
+  EinsteinAgentActionsOutputRepresentation:
+    description: Output representation for Agent Actions
+    type: object
+    properties:
+      actions:
+        description: Agent Actions
+        type: array
+        items:
+          type: EinsteinAgentActionOutputRepresentation
+  EinsteinAgentActionInputRepresentation:
+    description: Input representation for an Agent Action
+    type: object
+    properties:
+      description:
+        description: Description of the agent action
+        type: string
+      developerName:
+        description: Developer name of the agent action
+        type: string
+      invocationTargetIdentifier:
+        description: Invocation Target Identifier of the agent action
+        type: string
+      invocationTargetType:
+        description: Invocation Target Type of the agent action
+        type: string
+        enum:
+          - Flow
+      label:
+        description: Master Label of the agent action
+        type: string
+      serviceProcessId:
+        description: Service Process Identifier
+        type: string
+  DeploymentOutputRepresentation:
+    description: Template Deployment Output Representation
+    type: object
+    properties:
+      deploymentResult:
+        required: true
+        description: Result of the template deployment
+        type: string
+      templateId:
+        required: true
+        description: Template ID that was deployed
+        type: string
+      status:
+        required: true
+        description: Status of the deployment (SUCCESS or FAILURE)
+        type: string
+/connect/service-automation:
+  /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
+        queryParameters:
+          isRuntime:
+            type: boolean
+            required: false
+      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
+  /query:
+    post:
+      displayName: postServiceAutomation
+      description: POST Resource method to obtain Specified Class objects
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceAutomationDepOutputRepresentation
+      body:
+        application/json:
+          type: ServiceAutomationDepReadInputRepresentation
+          (oas-body-name): ServiceAutomationDepInput
+  /service-process:
+    /get-all-templates:
+      get:
+        displayName: getServiceProcessGetAllTemplates
+        description: API to retrieve the list of service process templates
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceProcessTemplatesOutputRepresentation
+  /gen-ai/actions:
+    get:
+      displayName: getAgentAction
+      description: Get a list of available Agent Actions
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EinsteinAgentActionsOutputRepresentation
+      queryParameters:
+        actionDevName:
+          type: string
+          required: false
+        resourceType:
+          type: string
+          required: false
+    post:
+      displayName: createAgentAction
+      description: Create an Agent Action
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EinsteinAgentActionOutputRepresentation
+      body:
+        application/json:
+          type: EinsteinAgentActionInputRepresentation
+          (oas-body-name): AgentActionInput
+  /agent/autolaunched-flow:
+    post:
+      displayName: postAgentFlowGeneration
+      description: API to create a flow for the new agent action
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: AgentAutolaunchedFlowRepresentation
+      body:
+        application/json:
+          type: AgentAutolaunchedFlowInputRepresentation
+          (oas-body-name): AgentAutolaunchedFlowInput
+  /intake-form:
+    /generate-intake-form:
+      post:
+        displayName: postGenerateIntakeForm
+        description: API to generate intake form for productId.
+        body:
+          application/json:
+            type: GenerateIntakeFormInputRepresentation
+            (oas-body-name): generateIntakeFormPayload
+        responses:
+          200:
+            description: Success
+            body:
+              application/json:
+                type: GenerateIntakeFormOutputRepresentation
+    /generate-intake-omniscript:
+      post:
+        displayName: postOmniIntake
+        description: API to generate omniscript for productId.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: OmniIntakeOutputRepresentation
+        body:
+          application/json:
+            type: IntakeFormCreationInputRepresentation
+            (oas-body-name): omniGenerateRequestPayload
+  /service-request/service-catalog-request/{serviceRequestId}:
+    get:
+      displayName: getServiceRequest
+      description: ECM API to fetch Service request record based on Service Request Id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ServiceRequestGetOutputRepresentation
+    uriParameters:
+      serviceRequestId:
+        description: serviceRequestId for which Service Request details have to be fetched.
+        type: string
+        required: true
+  /template/deploy/{templateId}:
+    uriParameters:
+      templateId:
+        description: Template ID to deploy
+        type: string
+        required: true
+    post:
+      displayName: postTemplateDeployment
+      description: API to deploy a template by template ID
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DeploymentOutputRepresentation