@salesforce/lds-adapters-industries-epc 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,1723 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.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:
+  DeactivateInputRepresentation:
+    description: Representation for list of Record Ids
+    type: object
+    properties:
+      entityName:
+        description: Name of entity
+        type: string
+      parentRecordId:
+        description: Parent Product Id for PAD records
+        type: string
+        required: false
+      recordIds:
+        description: List of record ids
+        type: array
+        items:
+          type: string
+  ErrorOutputRepresentation:
+    description: Error description
+    type: object
+    properties:
+      details:
+        description: List of record ids creating error
+        type: array
+        items:
+          type: string
+      message:
+        description: Human readable error message
+        type: string
+      reason:
+        description: Machine readable (string) error code
+        type: string
+
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  DeactivateInputRepresentationWrapper:
+    description: Wrapper for DeactivateInputRepresentation
+    type: object
+    properties:
+      deactivateInputPayload:
+        type: DeactivateInputRepresentation
+        description: Input representation for entityName and list of record ids
+
+  ProductAttributeDefinitionInputRepresentation:
+    description: An Input Representation for create Product-Attribute Definition Api.
+    type: object
+    properties:
+      attributeDefinitionId:
+        description: Attribute Definition Id
+        type: string
+      attributeDefinitionName:
+        description: AttributeDefinition Name
+        type: string
+      productId:
+        description: Product Id
+        type: string
+  ProductAttributeDefinitionListInputRepresentation:
+    description: Input representation for list of Product-Attribute Definition
+    type: object
+    properties:
+      productAttributeDefinitions:
+        description: List of Product-Attribute Definitions
+        type: array
+        items:
+          type: object
+
+    # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  ProductAttributeDefinitionListInputRepresentationWrapper:
+    description: Wrapper for ProductAttributeDefinitionListInputRepresentation
+    type: object
+    properties:
+      productAttributeDefinitionListInputPayload:
+        type: ProductAttributeDefinitionListInputRepresentation
+        description: Input representation for list of Product-Attribute Definition
+
+  ProductAttributeDefinitionListRepresentation:
+    description: Product-Attribute Definition List
+    type: object
+    properties:
+      data:
+        description: The list of Product-Attribute Definition records created
+        type: array
+        items:
+          type: ProductAttributeDefinitionRepresentation
+      message:
+        description: API result message
+        type: string
+  ProductAttributeDefinitionRepresentation:
+    description: Product-Attribute Definition
+    type: object
+    properties:
+      attributeDefinitionName:
+        description: The name of the attributeDefinition associated with the Product-Attribute
+          Definition
+        type: string
+        required: false
+      recordId:
+        description: The record Id of the Product-Attribute Definition
+        type: string
+        required: false
+  RecordIdMapOutputRepresentation:
+    description: Deactivate api response
+    type: object
+    properties:
+      errors:
+        description: The list of error messages
+        type: array
+        items:
+          type: ErrorOutputRepresentation
+      status:
+        description: Returns if the operation was a success or not
+        type: string
+  Status:
+    description: The output representation of the Status of the request.
+    type: object
+    properties:
+      code:
+        description: get Code.
+        type: string
+        required: false
+      message:
+        description: Get Error Message
+        type: string
+        required: false
+      errors:
+        description: get error details
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+  ProductFlowConnectRepresentation:
+    description: Product Flow Connect Representation Model
+    type: object
+    properties:
+      flowApiName:
+        description: flowApiName
+        type: string
+        required: false
+  ProductFlowOutputRepresentation:
+    description: Product Flow Output Representation Model
+    type: object
+    properties:
+      correlationId:
+        description: correlation id for the request
+        type: string
+        required: false
+      productFlow:
+        description: productFlow
+        type: ProductFlowConnectRepresentation
+        required: false
+      status:
+        description: API result status
+        type: Status
+        required: false
+  ProductOutputRepresentation:
+    description: EPC Product Definition
+    type: object
+    properties:
+      attributeCategory:
+        description: attributeCategory
+        type: array
+        required: false
+        items:
+          type: AttributeCategoryOutputRepresentation
+      attributes:
+        description: attributes
+        type: array
+        required: false
+        items:
+          type: AttributeDefinitionOutputRepresentation
+      categoryId:
+        description: categoryId
+        type: string
+        required: false
+      childProducts:
+        description: childProducts
+        type: array
+        required: false
+        items:
+          type: ProductOutputRepresentation
+      description:
+        description: description
+        type: string
+        required: false
+      displayUrl:
+        description: displayUrl
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      isComponentRequired:
+        description: isComponentRequired
+        type: boolean
+        required: false
+      isDefaultComponent:
+        description: isDefaultComponent
+        type: boolean
+        required: false
+      isQuantityEditable:
+        description: isQuantityEditable
+        type: boolean
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      nodeType:
+        description: nodeType
+        type: string
+        required: false
+      prices:
+        description: prices
+        type: array
+        required: false
+        items:
+          type: PriceOutputRepresentation
+      productClassification:
+        description: productClassification
+        type: ProductClassificationOutputRepresentation
+        required: false
+      productCode:
+        description: productCode
+        type: string
+        required: false
+      productComponentGroups:
+        description: productComponentGroups
+        type: array
+        required: false
+        items:
+          type: ProductComponentGroupOutputRepresentation
+      productSpecificationType:
+        description: productSpecificationType
+        type: ProductSpecificationTypeOutputRepresentation
+        required: false
+      quantityInfo:
+        description: getQuantityInfo
+        type: QuantityInfo
+        required: false
+  PCMRecordOutputRepresentation:
+    description: PCMRecord
+    type: object
+    properties:
+      id:
+        description: id
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+  RelatedObjectRecordsOutputRepresentation:
+    description: relatedRecords for a given recordId and relatedObject API Name
+    type: object
+    properties:
+      count:
+        description: count
+        type: integer
+      records:
+        description: The list of related Records
+        type: array
+        items:
+          type: PCMRecordOutputRepresentation
+      relatedObjectAPIName:
+        description: relatedObjectAPIName
+        type: string
+  RelatedRecordsInputRepresentation:
+    description: An input representation for related records Bulk Primitive Api.
+    type: object
+    properties:
+      correlationId:
+        description: correlationId
+        type: string
+        required: false
+      recordIds:
+        description: List of recordIds
+        type: array
+        items:
+          type: string
+      relatedObjectNodes:
+        description: List of related object nodes
+        type: array
+        items:
+          type: any
+  RelatedRecordsListOutputRepresentation:
+    description: Response of  related records Bulk Primitive Api.
+    type: object
+    properties:
+      correlationId:
+        description: correlation id for the request
+        type: string
+      relatedRecords:
+        description: The list of related records.
+        type: array
+        items:
+          type: RelatedRecordsOutputRepresentation
+      status:
+        description: API result status
+        type: Status
+  RelatedRecordsOutputRepresentation:
+    description: list of relatedObjectRecords for a given recordId
+    type: object
+    properties:
+      recordId:
+        description: The list of related Records
+        type: string
+      relatedObjectRecords:
+        description: relatedObjectRecords
+        type: array
+        items:
+          type: RelatedObjectRecordsOutputRepresentation
+  AttributeCategoryOutputRepresentation:
+    description: Attribute Category
+    type: object
+    properties:
+      attributes:
+        description: attributes
+        type: array
+        required: false
+        items:
+          type: AttributeDefinitionOutputRepresentation
+      code:
+        description: code
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+  AttributeDefinitionOutputRepresentation:
+    description: Attribute Definition
+    type: object
+    properties:
+      code:
+        description: code
+        type: string
+        required: false
+      dataType:
+        description: dataType
+        type: string
+        required: false
+      defaultHelpText:
+        description: defaultHelpText
+        type: string
+        required: false
+      defaultValue:
+        description: defaultValue
+        type: string
+        required: false
+      description:
+        description: description
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      isActive:
+        description: isActive
+        type: boolean
+        required: false
+      isCloneable:
+        description: isCloneable
+        type: boolean
+        required: false
+      isConfigurable:
+        description: isConfigurable
+        type: boolean
+        required: false
+      isEncrypted:
+        description: isEncrypted
+        type: boolean
+        required: false
+      isHidden:
+        description: isHidden
+        type: boolean
+        required: false
+      isPriceImpacting:
+        description: isPriceImpacting
+        type: boolean
+        required: false
+      isReadOnly:
+        description: isReadOnly
+        type: boolean
+        required: false
+      isRequired:
+        description: isRequired
+        type: boolean
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      picklist:
+        description: attributePicklist
+        type: AttributePicklistOutputRepresentation
+        required: false
+      valueDescription:
+        description: valueDescription
+        type: string
+        required: false
+  AttributePicklistOutputRepresentation:
+    description: Attribute PickList
+    type: object
+    properties:
+      code:
+        description: code
+        type: string
+        required: false
+      dataType:
+        description: dataType
+        type: string
+        required: false
+      description:
+        description: description
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      values:
+        description: attributePicklistValues
+        type: array
+        required: false
+        items:
+          type: AttributePicklistValueOutputRepresentation
+  AttributePicklistValueOutputRepresentation:
+    description: Attribute PickList Value
+    type: object
+    properties:
+      abbreviation:
+        description: abbreviation
+        type: string
+        required: false
+      code:
+        description: code
+        type: string
+        required: false
+      displayValue:
+        description: displayValue
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      isBooleanValue:
+        description: isBooleanValue
+        type: boolean
+        required: false
+      isDefault:
+        description: isDefault
+        type: boolean
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      sequence:
+        description: sequence
+        type: string
+        required: false
+      textValue:
+        description: textValue
+        type: string
+        required: false
+  PriceOutputRepresentation:
+    description: EPC Product Price Definition
+    type: object
+    properties:
+      effectiveFrom:
+        description: effectiveFrom
+        type: string
+        required: false
+      effectiveTo:
+        description: effectiveTo
+        type: string
+        required: false
+      priceListEntryId:
+        description: priceListEntryId
+        type: string
+        required: false
+      pricebookId:
+        description: pricebookId
+        type: string
+        required: false
+      pricingModel:
+        description: pricingModel
+        type: PricingModelOutputRepresentation
+        required: false
+      unitPrice:
+        description: unitPrice
+        type: string
+        required: false
+  PricingModelOutputRepresentation:
+    description: EPC Product Pricing Model Definition
+    type: object
+    properties:
+      frequency:
+        description: frequency
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      occurrence:
+        description: occurrence
+        type: integer
+        required: false
+      pricingModelType:
+        description: pricingModelType
+        type: string
+        required: false
+      unitOfMeasure:
+        description: frequency
+        type: string
+        required: false
+  ProductClassificationOutputRepresentation:
+    description: The output representation of the product classification info.
+    type: object
+    properties:
+      id:
+        description: id
+        type: string
+        required: false
+  ProductComponentGroupOutputRepresentation:
+    description: ProductComponentGroupOutputRepresentation
+    type: object
+    properties:
+      code:
+        description: code
+        type: string
+        required: false
+      components:
+        description: components
+        type: array
+        required: false
+        items:
+          type: ProductOutputRepresentation
+      description:
+        description: description
+        type: string
+        required: false
+      id:
+        description: id
+        type: string
+        required: false
+      maxBundleComponents:
+        description: maxBundleComponents
+        type: integer
+        required: false
+      minBundleComponents:
+        description: minBundleComponents
+        type: integer
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      parentProductId:
+        description: parentProductId
+        type: string
+        required: false
+      sequence:
+        description: sequence
+        type: integer
+        required: false
+  ProductSpecificationRecordTypeOutputRepresentation:
+    description: ProductSpecificationRecordTypeOutputRepresentation
+    type: object
+    properties:
+      isCommercial:
+        description: isCommercial
+        type: boolean
+        required: false
+  ProductSpecificationTypeOutputRepresentation:
+    description: ProductSpecificationTypeOutputRepresentation
+    type: object
+    properties:
+      name:
+        description: productSpecificationTypeName
+        type: string
+        required: false
+  ProductsOutputRepresentation:
+    description: Products list
+    type: object
+    properties:
+      correlationId:
+        description: correlation id for the request
+        type: string
+        required: false
+      count:
+        description: count
+        type: integer
+        required: false
+      products:
+        description: The list of products
+        type: array
+        required: false
+        items:
+          type: ProductOutputRepresentation
+      status:
+        description: API result status
+        type: Status
+        required: false
+  ConfigRuleHashColumnInfoOutputRepresentation:
+    description: Response Model for the config rule hash column details
+    type: object
+    properties:
+      datatype:
+        description: Config Rule Hash Column Datatype
+        type: string
+        required: false
+      title:
+        description: Config Rule Hash Column Title
+        type: string
+        required: false
+  ConfigRuleHashColumnsInfoOutputRepresentation:
+    description: Response Model for the list of Config Rule HashColumns
+    type: object
+    properties:
+      configRuleHashColumnsInfo:
+        description: Config Rule Hash Column List
+        type: array
+        items:
+          type: ConfigRuleHashColumnInfoOutputRepresentation
+  ConfigRuleMetadataOutputRepresentation:
+    description: Response Model for the Context Definition API
+    type: object
+    properties:
+      configRuleHashColumns:
+        description: Config Rule Hash Columns
+        type: ConfigRuleHashColumnsInfoOutputRepresentation
+        required: false
+      contextDefinitionId:
+        description: Context Definition Id
+        type: string
+        required: false
+      contextDefinitionName:
+        description: Context Definition Name
+        type: string
+        required: false
+      contextNodes:
+        description: Context Node List
+        type: ContextNodesInfoOutputRepresentation
+        required: false
+      correlationId:
+        description: Correlation ID associated to the request
+        type: string
+        required: false
+      status:
+        description: API result status
+        type: Status
+        required: false
+  ContextDefinitionOutputRepresentation:
+    description: Response Model for the Context Definition API
+    type: object
+    properties:
+      contextDefinitionId:
+        description: Context Definition Id
+        type: string
+        required: false
+      contextDefinitionName:
+        description: Context Definition Name
+        type: string
+        required: false
+      contextNodes:
+        description: Context Node List
+        type: ContextNodesInfoOutputRepresentation
+        required: false
+      correlationId:
+        description: Correlation ID associated to the request
+        type: string
+        required: false
+      status:
+        description: API result status
+        type: Status
+        required: false
+  ContextFieldInfoOutputRepresentation:
+    description: Response Model for the Context Field details
+    type: object
+    properties:
+      apiName:
+        description: apiName of field
+        type: string
+        required: false
+      dataType:
+        description: Data type of field
+        type: string
+        required: false
+      fieldType:
+        description: Context field type ie Input/Output/InputOutput
+        type: string
+        required: false
+      name:
+        description: Name of field
+        type: string
+        required: false
+      parentNodeName:
+        description: Context Parent Node Name
+        type: string
+        required: false
+      path:
+        description: Path to field in the context
+        type: string
+        required: false
+  ContextFieldsInfoOutputRepresentation:
+    description: Response Model for the list of  Context Field details
+    type: object
+    properties:
+      contextFieldsInfo:
+        description: Context Fields Info
+        type: array
+        items:
+          type: ContextFieldInfoOutputRepresentation
+  ContextNodeInfoOutputRepresentation:
+    description: Response Model for the Context Node details
+    type: object
+    properties:
+      apiName:
+        description: apiName of Node
+        type: string
+        required: false
+      childNodes:
+        description: Nested Context Node List
+        type: ContextNodesInfoOutputRepresentation
+        required: false
+      fields:
+        description: Context Node Fields List
+        type: ContextFieldsInfoOutputRepresentation
+        required: false
+      name:
+        description: Context Node name
+        type: string
+        required: false
+      parentNodeName:
+        description: Context Parent Node Name
+        type: string
+        required: false
+      path:
+        description: Context Node Full Path
+        type: string
+        required: false
+  ContextNodesInfoOutputRepresentation:
+    description: Response Model for the list of Context Node details
+    type: object
+    properties:
+      contextNodesInfo:
+        description: Context Node List
+        type: array
+        items:
+          type: ContextNodeInfoOutputRepresentation
+  QuantityInfo:
+    description: The output representation of the quantity info about a product.
+    type: object
+    properties:
+      maxQuantity:
+        description: getMaxQuantity
+        format: double
+        type: number
+        required: false
+      minQuantity:
+        description: getMinQuantity
+        format: double
+        type: number
+        required: false
+      quantity:
+        description: getQuantity
+        format: double
+        type: number
+        required: false
+  SnapshotCollectionOutputRepresentation:
+    description: Output Representation of Read Snapshot Resource
+    type: object
+    properties:
+      snapshots:
+        description: Returns the list of Active and Future Snapshots
+        type: array
+        required: false
+        items:
+          type: SnapshotOutputRepresentation
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      statusCode:
+        description: statusCode
+        type: string
+        required: false
+  SnapshotIndexOutputRepresentation:
+    description: Runtime Catalog Snapshot Index Response
+    type: object
+    properties:
+      completedDate:
+        description: completed date of the index
+        type: string
+        required: false
+      createdDate:
+        description: created date of the index
+        type: string
+        required: false
+      id:
+        description: id of the snapshot index
+        type: string
+        required: false
+      indexBuildType:
+        description: index build type
+        type: string
+        required: false
+      indexInfos:
+        description: index info records for the snapshot index
+        type: array
+        required: false
+        items:
+          type: SnapshotIndexInfoOutputRepresentation
+      indexLogs:
+        description: index logs for the snapshot index
+        type: array
+        required: false
+        items:
+          type: SnapshotIndexLogOutputRepresentation
+      indexType:
+        description: index type of the snapshot index
+        type: string
+        required: false
+      lastBuildStatus:
+        description: last build status of the index
+        type: string
+        required: false
+      numberOfRecords:
+        description: number of records indexed
+        type: integer
+        required: false
+      venueId:
+        description: venue id of the snapshot index
+        type: string
+        required: false
+  SnapshotOutputRepresentation:
+    description: Runtime Catalog Snapshot Response
+    type: object
+    properties:
+      activationDate:
+        description: activate date of the snapshot
+        type: string
+        required: false
+      activationStatus:
+        description: activation status of the snapshot
+        type: string
+        required: false
+      activationType:
+        description: activation type of the snapshot
+        type: string
+        required: false
+      id:
+        description: id of the snapshot
+        type: string
+        required: false
+      snapshotIndexes:
+        description: list of snapshot indexes
+        type: array
+        required: false
+        items:
+          type: SnapshotIndexOutputRepresentation
+  SnapshotDeploymentInputRepresentation:
+    description: Input representation for deploying a snapshot of runtime catalog
+    type: object
+    properties:
+      buildType:
+        description: Type of index build
+        type: string
+        required: false
+      snapshot:
+        description: snapshot to deploy
+        type: any
+        required: false
+  RuntimeCatalogSnapshotInputRepresentation:
+    description: Input Representation for deploying a runtime catalog snapshot.
+    type: object
+    properties:
+      activationDate:
+        description: activate date of the snapshot
+        type: string
+        required: false
+      activationType:
+        description: activation type of the snapshot
+        type: string
+        required: false
+      id:
+        description: id of the snapshot
+        type: string
+        required: false
+  SnapshotDeploymentOutputRepresentation:
+    description: Snapshot Deployment response
+    type: object
+    properties:
+      snapshot:
+        description: Runtime Catalog Snapshot for which the index was created.
+        type: SnapshotOutputRepresentation
+        required: false
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      statusCode:
+        description: statusCode
+        type: string
+  SnapshotIndexInfoOutputRepresentation:
+    description: Output Representation of a snapshot index info.
+    type: object
+    properties:
+      buildType:
+        description: Build type of the index (Full or Incremental)
+        type: string
+        required: false
+      id:
+        description: id of the index info record
+        type: string
+        required: false
+      isIncrementable:
+        description: Indicates if partial build is enabled or disabled
+        type: boolean
+        required: false
+      usageType:
+        description: Usage type of the index (Live or Out of use)
+        type: string
+        required: false
+        enum:
+          - Live
+          - OutOfUse
+  SnapshotIndexLogOutputRepresentation:
+    description: Output Representation of a snapshot index log.
+    type: object
+    properties:
+      catalogSnapshotTime:
+        description: Catalog snapshot time of the index
+        type: string
+        required: false
+      completionTime:
+        description: Completion time of the index
+        type: string
+        required: false
+      createdById:
+        description: ID of the user that initiated the index build
+        type: string
+        required: false
+      indexBuildStatus:
+        description: Status of the index build
+        type: string
+        required: false
+      indexBuildType:
+        description: Type of the index build (Full or Incremental).
+        type: string
+        required: false
+      indexId:
+        description: id of the index
+        type: string
+        required: false
+      message:
+        description: message for the index status
+        type: string
+        required: false
+      numberOfChanges:
+        description: Number of new or changed products included in the index
+        type: integer
+        required: false
+  IndexConfigurationCollectionInputRepresentation:
+    description: Input Representation for collection of IndexConfigurations
+    type: object
+    properties:
+      correlationId:
+        description: correlationId
+        type: string
+        required: false
+      indexConfigurations:
+        description: indexConfigurations
+        type: array
+        required: false
+        items:
+          type: any
+  IndexConfigurationInputRepresentation:
+    description: Input Representation for persisting IndexConfiguration
+    type: object
+    properties:
+      attributeDefinitionId:
+        description: attributeDefinitionId
+        type: string
+        required: false
+      attributeFieldId:
+        description: attributeFieldId
+        type: string
+        required: false
+      isDisplayable:
+        description: isDisplayable
+        type: boolean
+        required: false
+      isSearchable:
+        description: isSearchable
+        type: boolean
+        required: false
+      isFacetable:
+        description: isFacetable
+        type: boolean
+        required: false
+      facetDisplayRank:
+        description: facetDisplayRank
+        type: integer
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      type:
+        description: type
+        type: string
+        required: false
+  IndexConfigurationCollectionOutputRepresentation:
+    description: Collection of index configuration details
+    type: object
+    properties:
+      correlationId:
+        description: correlation id for the request
+        type: string
+        required: false
+      indexConfigurations:
+        description: index configurations
+        type: array
+        required: false
+        items:
+          type: IndexConfigurationFieldOutputRepresentation
+      metadata:
+        description: metadata information
+        type: MetadataOutputRepresentation
+        required: false
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      statusCode:
+        description: statusCode
+        type: string
+        required: false
+  IndexConfigurationsUpdateOutputRepresentation:
+    description: Update index configuration response representation
+    type: object
+    properties:
+      correlationId:
+        description: correlation id for the request
+        type: string
+        required: false
+      indexConfigurations:
+        description: index configurations
+        type: array
+        required: false
+        items:
+          type: IndexConfigurationFieldOutputRepresentation
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      statusCode:
+        description: statusCode
+        type: string
+  IndexConfigurationFieldOutputRepresentation:
+    description: Details of the index configured field
+    type: object
+    properties:
+      attributeDefinitionId:
+        description: attributeDefinitionId
+        type: string
+        required: false
+      attributeFieldId:
+        description: attributeFieldId
+        type: string
+        required: false
+      isDisplayable:
+        description: IsDisplayable
+        type: boolean
+        required: false
+      isSearchable:
+        description: IsSearchable
+        type: boolean
+        required: false
+      isFacetable:
+        description: isFacetable
+        type: boolean
+        required: false
+      facetDisplayRank:
+        description: facetDisplayRank
+        type: integer
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      type:
+        description: type
+        type: string
+        required: false
+  MetadataOutputRepresentation:
+    description: Metadata information. Contains lists of different metadata types
+    type: object
+    properties:
+      objectInfos:
+        description: Metadata information for objects
+        type: array
+        required: false
+        items:
+          type: ObjectInfoOutputRepresentation
+  ObjectInfoOutputRepresentation:
+    description: The object along with it's fields
+    type: object
+    properties:
+      fields:
+        description: Fields of the Entity
+        type: array
+        required: false
+        items:
+          type: FieldsInfoOutputRepresentation
+      name:
+        description: Name of the Entity
+        type: string
+        required: false
+  FieldsInfoOutputRepresentation:
+    description: The metadata fields in an object
+    type: object
+    properties:
+      customFieldId:
+        description: customFieldId
+        type: string
+        required: false
+      isConfigurable:
+        description: isConfigurable
+        type: boolean
+        required: false
+      isFacetableConfigurable:
+        description: isFacetableConfigurable
+        type: boolean
+        required: false
+      isSearchableConfigurable:
+        description: isSearchableConfigurable
+        type: boolean
+        required: false
+      label:
+        description: label
+        type: string
+        required: false
+      name:
+        description: name
+        type: string
+        required: false
+      type:
+        description: type
+        type: string
+        required: false
+  EpcErrorOutputRepresentation:
+    description: EPC Error description
+    type: object
+    properties:
+      errorCode:
+        description: errorCode
+        type: string
+        required: false
+      messageDetail:
+        description: messageDetail
+        type: string
+        required: false
+      messageTitle:
+        description: messageTitle
+        type: string
+        required: false
+      nodeProductId:
+        description: nodeProductId
+        type: string
+        required: false
+      recordId:
+        description: recordId
+        type: string
+        required: false
+      recordName:
+        description: recordName
+        type: string
+        required: false
+      source:
+        description: The api name during which the error is encountered
+        type: string
+        required: false
+  IndexSettingInputRepresentation:
+    description: Input Representation for Index Setting
+    type: object
+    properties:
+      setting:
+        description: setting
+        type: SettingInputRepresentation
+        required: false
+  SettingInputRepresentation:
+    description: Input Representation for Setting
+    type: object
+    properties:
+      defaultLanguage:
+        description: default Language
+        type: string
+        required: false
+      supportedLanguages:
+        description: supportedLanguages
+        type: array
+        required: false
+        items:
+          type: string
+  IndexSettingOutputRepresentation:
+    description: Index Setting Get Response
+    type: object
+    properties:
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      metadata:
+        description: Metadata for the Setting
+        type: SettingMetadataOutputRepresentation
+        required: false
+      setting:
+        description: Setting maintained for an org used in Indexing
+        type: SettingOutputRepresentation
+        required: false
+      statusCode:
+        description: statusCode
+        type: string
+  SettingMetadataOutputRepresentation:
+    description: Setting Metadata Response
+    type: object
+    properties:
+      activeLanguages:
+        description: list of active languages in an org
+        type: array
+        required: false
+        items:
+          type: string
+  SettingOutputRepresentation:
+    description: Setting Response
+    type: object
+    properties:
+      id:
+        description: id of the setting
+        type: string
+        required: false
+      defaultLanguage:
+        description: Default Language for the API
+        type: string
+        required: false
+      supportedLanguages:
+        description: list of supported languages
+        type: array
+        required: false
+        items:
+          type: string
+  IndexSettingPatchOutputRepresentation:
+    description: Index Setting Patch Response
+    type: object
+    properties:
+      errors:
+        description: errors
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      setting:
+        description: Setting maintained for an org used in Indexing
+        type: SettingOutputRepresentation
+        required: false
+      statusCode:
+        description: statusCode
+        type: string
+  SnapshotIndexErrorOutputRepresentation:
+    description: Output Representation of Snapshot Index Error Resource
+    type: object
+    properties:
+      errors:
+        description: List of errors encountered during the processing of the API request
+        type: array
+        required: false
+        items:
+          type: EpcErrorOutputRepresentation
+      indexErrorDetails:
+        description: Count and details of errors that occurred during indexing.
+        type: IndexErrorOutputRepresentation
+        required: false
+      statusCode:
+        description: Code indicating the status of the API request.
+        type: string
+  IndexErrorOutputRepresentation:
+    description: Index Error Response
+    type: object
+    properties:
+      errorFileId:
+        description: ID of the exported error file that contains index errors.
+        type: string
+        required: false
+      indexCreatedDate:
+        description: Creation date of the index
+        type: string
+        required: false
+      indexErrorsCount:
+        description: Number of index-level errors
+        type: integer
+        required: false
+      indexLastUpdatedDate:
+        description: Date on which the index was last updated.
+        type: string
+        required: false
+      itemLevelErrorsCount:
+        description: Number of item-level errors
+        type: integer
+        required: false
+  CatalogUpdateInputRepresentation:
+    description: Input Representation for PCM Catalog Update.
+    type: object
+    properties:
+      correlationId:
+        description: correlationId
+        type: string
+        required: false
+      objectGraph:
+        description: objectGraph
+        type: object
+        properties:
+          //:
+            type: any
+      source:
+        description: source
+        type: string
+  CatalogUpdateResponseRepresentation:
+    description: Catalog Update Response
+    type: object
+    properties:
+      correlationId:
+        description: CorrelationId as passed in request
+        type: string
+      graphResponse:
+        description: response to graph request
+        type: CatalogUpdateGraphOutputRepresentation
+        required: false
+      isSuccessful:
+        description: Successful
+        type: boolean
+        required: false
+      source:
+        description: Source as passed in request
+        type: string
+        required: false
+      status:
+        description: API result status
+        type: Status
+        required: false
+  CatalogUpdateGraphOutputRepresentation:
+    description: Catalog Update Graph Response
+    type: object
+    properties:
+      graphId:
+        description: graphId as passed in request
+        type: string
+        required: false
+      records:
+        description: response to graph request
+        type: array
+        items:
+          type: RecordUpdateOutputRepresentation
+        required: false
+  RecordUpdateOutputRepresentation:
+    description: Record Update Response
+    type: object
+    properties:
+      error:
+        description: error
+        type: EpcErrorOutputRepresentation
+        required: false
+      recordIdentifier:
+        description: SObject identifier of record
+        type: string
+        required: false
+      referenceId:
+        description: ReferenceId of record as in request
+        type: string
+        required: false
+      type:
+        description: SObject type of record
+        type: string
+        required: false
+
+/connect/pcm:
+  /actions/catalog-update:
+    post:
+      displayName: postCatalogUpdate
+      description: PCM Catalog Update API to update records of allowed types.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CatalogUpdateResponseRepresentation
+      body:
+        application/json:
+          type: CatalogUpdateInputRepresentation
+          (oas-body-name): catalogUpdateRequestPayload
+  /actions/deactivate:
+    patch:
+      description: Deactivate batch of records for an entity
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecordIdMapOutputRepresentation
+      body:
+        application/json:
+          # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+          type: DeactivateInputRepresentationWrapper
+          # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): deactivateInputPayload
+  /index:
+    /configurations:
+      get:
+        displayName: getIndexConfiguration
+        description: Get index configurations
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: IndexConfigurationCollectionOutputRepresentation
+        queryParameters:
+          correlationId:
+            type: string
+            required: false
+          fieldTypes:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          includeMetadata:
+            type: boolean
+            required: false
+      put:
+        displayName: putIndexConfiguration
+        description: Update index configurations
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: IndexConfigurationsUpdateOutputRepresentation
+        body:
+          application/json:
+            type: IndexConfigurationCollectionInputRepresentation
+            (oas-body-name): epcIndexConfigurationRequestPayload
+    /deploy:
+      post:
+        displayName: postSnapshotDeployment
+        description: Post for deploying snapshot indexes
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SnapshotDeploymentOutputRepresentation
+        body:
+          application/json:
+            type: SnapshotDeploymentInputRepresentation
+            (oas-body-name): deploySnapshotInput
+    /setting:
+      get:
+        displayName: getIndexSetting
+        description: API to fetch the Setting used in Indexing
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: IndexSettingOutputRepresentation
+      patch:
+        displayName: patchIndexSetting
+        description: API to patch the Setting used in Indexing
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: IndexSettingPatchOutputRepresentation
+        queryParameters:
+          settingId:
+            type: string
+            required: false
+        body:
+          application/json:
+            type: IndexSettingInputRepresentation
+            (oas-body-name): epcIndexSettingRequestPayload
+    /snapshots:
+      get:
+        displayName: getSnapshot
+        description: API to fetch all Active and Future Snapshots
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SnapshotCollectionOutputRepresentation
+        queryParameters:
+          numberOfIndexLogs:
+            type: integer
+            required: false
+    /error:
+      get:
+        displayName: getSnapshotIndexError
+        description: API to fetch the errors for the given index and snapshot index
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SnapshotIndexErrorOutputRepresentation
+        queryParameters:
+          indexId:
+            type: string
+            required: false
+          snapshotIndexId:
+            type: string
+            required: false
+  /product-attribute-definition:
+    post:
+      description: Create Product-Attribute Definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProductAttributeDefinitionListRepresentation
+      body:
+        application/json:
+          # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+          type: ProductAttributeDefinitionListInputRepresentationWrapper
+          # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          # required: false
+          (oas-body-name): productAttributeDefinitionListInputPayload
+  /products/{productId}/flow:
+    get:
+      description: API to fetch product flow based on the product id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProductFlowOutputRepresentation
+      queryParameters:
+        correlationId:
+          type: string
+          required: false
+        assignmentType:
+          type: string
+          required: false
+    uriParameters:
+      productId:
+        description: Product Id for which flow details has to be fetched.
+        type: string
+        required: true
+  /product/{productId}/attributes:
+    get:
+      description: API to fetch EPC product attributes based on product id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProductOutputRepresentation
+      queryParameters:
+        correlationId:
+          type: string
+          required: false
+        isPriceImpacting:
+          type: boolean
+          required: false
+    uriParameters:
+      productId:
+        description: Product Id for which product details have to be fetched.
+        type: string
+        required: true
+  /products/{productId}:
+    get:
+      displayName: getProducts
+      description: API to fetch EPC product record based on product id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ProductsOutputRepresentation
+      queryParameters:
+        correlationId:
+          type: string
+          required: false
+  /configurationRule/context-definition/{contextDefinitionId}:
+    get:
+      displayName: getContextDefinition
+      description: API to fetch context definition info based on the context definition id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContextDefinitionOutputRepresentation
+      queryParameters:
+        correlationId:
+          type: string
+          required: false
+  /configurationRule/config-rule-metadata/{usageType}/{usageSubType}:
+    get:
+      displayName: getConfigRuleMetadata
+      description: API to fetch context definition info based on the context definition
+        id.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ConfigRuleMetadataOutputRepresentation
+      queryParameters:
+        correlationId:
+          type: string
+          required: false
+    uriParameters:
+      usageType:
+        description: USAGE_TYPE for which context definition info has to be fetched.
+        type: string
+        required: true
+      usageSubType:
+        description: USAGE_SUB_TYPE for which hash values info has to be fetched.
+        type: string
+        required: true
+  /relatedRecords/{entityName}:
+    post:
+      displayName: postRelatedRecords
+      description: EPC primitive API to retrieve related records for a given entity.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RelatedRecordsListOutputRepresentation
+      body:
+        application/json:
+          type: RelatedRecordsInputRepresentation
+          (oas-body-name): epcProductRequestPayload
+    uriParameters:
+      entityName:
+        description: Entity Name for which relatedRecords are to be fetched.
+        type: string
+        required: true