@salesforce/lds-adapters-industries-epc 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,222 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  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
+      message:
+        description: Get Error Message
+        type: string
+  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
+/connect/epc:
+  /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
+  /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
+    uriParameters:
+      productId:
+        description: Product Id for which flow details has to be fetched.
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,36 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'epc'
+(luvio.ttl): 360000
+
+types:
+  RecordIdMapOutputRepresentation:
+    (luvio.ttl): 6000
+    (luvio.opaque): true
+    (luvio.key):
+      message: status
+  ProductAttributeDefinitionListRepresentation:
+    (luvio.ttl): 6000
+    (luvio.opaque): true
+    (luvio.key):
+      message: message
+  ProductFlowOutputRepresentation:
+    (luvio.ttl): 6000
+    (luvio.opaque): true
+/connect/epc:
+  /actions/deactivate:
+    patch:
+      (luvio.adapter):
+        name: deactivate
+  /product-attribute-definition:
+    post:
+      (luvio.adapter):
+        name: createProductAttributeDefinition
+  /products/{productId}/flow:
+    get:
+      (luvio.adapter):
+        name: getProductFlowByProductId