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

package/src/raml/api.raml

@@ -0,0 +1,541 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  ActionPlanItemCollectionRepresentation:
+    description: Record Representation of Collection of ActionPlanItems
+    type: object
+    properties:
+      records:
+        description: Specifies the collection of records of ActionPlanItem
+        type: array
+        items:
+          type: ActionPlanItemDetailedRepresentation
+  ActionPlanItemDetailedRepresentation:
+    description: Record Representation of ActionPlanItem
+    type: object
+    properties:
+      actionPlanItemTask:
+        description: Returns the data of the item associated with the ActionPlanItem
+        type: ActionPlanItemTaskRepresentation
+        required: false
+      id:
+        description: ID of this record.
+        type: string
+      isRequired:
+        description: Returns if the ActionPlanItem is mandatory or not
+        type: boolean
+  ActionPlanItemListRepresentation:
+    description: Representation for list of mandatory Action Plan Items that are pending
+    type: object
+    properties:
+      records:
+        description: List of mandatory action plan items that are pending
+        type: array
+        items:
+          type: ActionPlanItemRepresentation
+  ActionPlanItemRepresentation:
+    description: Representation of Action Plan Item
+    type: object
+    properties:
+      id:
+        description: ID of the Action Plan Item
+        type: string
+  ActionPlanItemTaskRepresentation:
+    description: Record Representation of ActionPlanItemTask
+    type: object
+    properties:
+      computedFields:
+        description: Fields computed by service layer
+        type: ComputedFieldsWrapperRepresentation
+        required: false
+      fields:
+        description: The fields for the task
+        type: array
+        required: false
+        items:
+          type: FieldRepresentation
+      id:
+        description: ID of this record.
+        type: string
+      progress:
+        description: The progress of task
+        type: TaskProgressRepresentation
+        required: false
+  ActionPlanItemsWrapperRepresentation:
+    description: Record Representation of ActionPlanItemsWrapper
+    type: object
+    properties:
+      actionPlanItems:
+        description: Specifies the wrapper of records of ActionPlanItems
+        type: ActionPlanItemCollectionRepresentation
+  ActionPlanStatusInfoOutputRepresentation:
+    description: Representation for Action Plan Status which tells whether all mandatory
+      tasks are completed
+    type: object
+    properties:
+      mandatoryItemsCompleted:
+        description: Whether all mandatory Items are completed
+        type: boolean
+      mandatoryItemsPending:
+        description: List of Mandatory Action Plan Items that are pending
+        type: ActionPlanItemListRepresentation
+        required: false
+      optionalItemsCompleted:
+        description: Whether all optional items are completed
+        type: boolean
+      statusCode:
+        description: Current status code of Action Plan
+        type: string
+        required: false
+  ComputedFieldsWrapperRepresentation:
+    description: Record Representation of ComputedFieldsWrapper
+    type: object
+    properties:
+      fields:
+        description: Specifies computed fields of the ActionPlanItemTask
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-Rolled W-8252808
+  FieldRepresentation:
+    description: Output representation of a single field
+    type: object
+    properties:
+      colType:
+        description: The column type (date, currency, etc.)
+        type: string
+      fieldName:
+        description: The field name
+        type: string
+      label:
+        description: Label of the field
+        type: string
+      value:
+        description: The value of the field
+        type: string
+  TaskProgressRepresentation:
+    description: Output represenation of a task progress
+    type: object
+    properties:
+      currentValue:
+        description: The current value of progress
+        type: integer
+      maxValue:
+        description: The max value of progress
+        type: integer
+      minValue:
+        description: The min value of progress
+        type: integer
+  ActionPlanListRepresentation:
+    description: Representation of Action Plan List
+    type: object
+    properties:
+      records:
+        description: List of action plan records
+        type: array
+        items:
+          type: ActionPlanRepresentation
+  ActionPlanRepresentation:
+    description: Representation of Action Plan
+    type: object
+    properties:
+      id:
+        description: ID of the Action Plan
+        type: string
+      itemCount:
+        description: Total number of Action Plan Item present in Action Plan
+        type: integer
+        required: false
+      name:
+        description: Name of the Action Plan
+        type: string
+      statusCode:
+        description: Status Code for the Action Plan
+        type: string
+        required: false
+  ActionPlansWrapperOutputRepresentation:
+    description: Representation of Action Plans List Api Output
+    type: object
+    properties:
+      actionPlan:
+        description: List of Action Plans
+        type: ActionPlanListRepresentation
+  ActionPlanTemplateDCIItemsLabelOutputRepresentation:
+    description: Representation of Action Plans Template DCI Items
+    type: object
+    properties:
+      itemValues:
+        description: List of item values
+        type: array
+        items:
+          type: ActionPlanTemplateItemValuesLabelOutputRepresentation
+      isRequired:
+        description: Item is required or not
+        type: boolean
+  ActionPlanTemplateItemValuesLabelOutputRepresentation:
+    description: Representation of Action Plans Template Item Values
+    type: object
+    properties:
+      itemEntityFieldName:
+        description: The item entity type
+        type: string
+      label:
+        description: Item label
+        type: string
+      valueFormula:
+        description: The item value formula
+        type: string
+      valueLiteral:
+        description: The item value literal
+        type: string
+  ActionPlanTemplateTaskItemsLabelOutputRepresentation:
+    description: Representation of Action Plans Template Task Items
+    type: object
+    properties:
+      assignedToUserName:
+        description: Name of Action Plan Task assigned user
+        type: string
+      itemValues:
+        description: List of Task item details
+        type: array
+        items:
+          type: ActionPlanTemplateItemValuesLabelOutputRepresentation
+      isRequired:
+        description: Is required Action Plan task item
+        type: boolean
+      prerequisiteTasks:
+        description: List of prerequisite tasks
+        type: array
+        items:
+          type: string
+  ActionPlanTemplateItemsLabelOutputRepresentation:
+    description: Representation of Action Plans Template Items
+    type: object
+    properties:
+      actionPlanType:
+        description: Action Plan Type
+        type: string
+      createdByUserName:
+        description: Item assigned to user name
+        type: string
+      isCreateAdhocItemsAllowed:
+        description: isCreateAdhocItemsAllowed description
+        type: boolean
+      actionPlanTemplateName:
+        description: actionPlanTemplateName description
+        type: string
+      targetEntityType:
+        description: Target Entity Type
+        type: string
+      dciItemList:
+        description: List of dci
+        type: array
+        items:
+          type: ActionPlanTemplateDCIItemsLabelOutputRepresentation
+      taskItemList:
+        description: List of all task items
+        type: array
+        items:
+          type: ActionPlanTemplateTaskItemsLabelOutputRepresentation
+  ActionPlanTemplateUpdateInputRepresentation:
+    description: Input representation for Action Plan Template Inline Edit
+    type: object
+    properties:
+      actionPlanTemplateItems:
+        description: Action Plan Template Items
+        type: array
+        items:
+          #TODO: Hand-rolled
+          type: ActionPlanTemplateItemUpdateInputRepresentation
+  ActionPlanTemplateItemUpdateInputRepresentation:
+    description: Input representation for the inline edit of ActionPlanTemplate Tasks
+    type: object
+    properties:
+      actionPlanTemplateItemId:
+        description: ActionPlanTemplateItem Id
+        type: string
+      actionPlanTemplateItemValues:
+        description: ActionPlanTemplateItem Values to be updated
+        type: array
+        required: false
+        items:
+          #TODO: Hand-rolled
+          type: ActionPlanTemplateItemValueUpdateInputRepresentation
+      isRequired:
+        description: Is ActionPlanTemplateItem Required
+        type: boolean
+        required: false
+      subject:
+        description: ActionPlanTemplateItem Subject
+        type: string
+        required: false
+  ActionPlanTemplateItemValueUpdateInputRepresentation:
+    description: Input representation for the inline edit of ActionPlanTemplate Tasks
+    type: object
+    properties:
+      actionPlanTemplateItemValueId:
+        description: ActionPlanTemplateItemValueId
+        type: string
+        required: false
+      fieldValueFormula:
+        description: Value Formula
+        type: string
+        required: false
+      fieldValueLiteral:
+        description: Value Literal
+        type: any
+        required: false
+      itemEntityFieldName:
+        description: Item Entity Field Name
+        type: string
+        required: false
+  ActionPlanTemplateUpdateOutputRepresentation:
+    description: Output representation for update of Action Plan Template tasks from
+      inline edit
+    type: object
+    properties:
+      actionPlanTemplateVersionId:
+        description: Action Plan Template Version Id of the updated items
+        type: string
+      errors:
+        description: Inline Edit Errors for Action Plan Template Items
+        type: array
+        items:
+          type: ActionPlanTemplateUpdateErrorOutputRepresentation
+      message:
+        description: Update Message
+        type: string | nil
+      status:
+        description: Success/Failure update status
+        type: string
+  ActionPlanTemplateUpdateErrorOutputRepresentation:
+    description: Output representation for errors during update of Action Plan Template
+      tasks from inline edit
+    type: object
+    properties:
+      actionPlanTemplateItemId:
+        description: The action plan template item Id
+        type: string
+      errorMessage:
+        description: Error during the update of action plan template task
+        type: array
+        items:
+          type: string
+  ActionPlanUpdateInputRepresentation:
+    description: Input representation for Action Plan  Inline Edit
+    type: object
+    properties:
+      actionPlanTasks:
+        description: Action Plan Template Items
+        type: array
+        #TODO: Hand-rolled
+        items:
+          type: ActionPlanTaskUpdateInputRepresentation
+  ActionPlanTaskUpdateInputRepresentation:
+    description: Input representation for Action Plan Task edited
+    type: object
+    properties:
+      actionPlanItemId:
+        description: ActionPlanItem Id
+        type: string
+        required: false
+      taskFieldValues:
+        description: Task Field Values List
+        type: array
+        #TODO: Hand-rolled
+        items:
+          type: ActionPlanTaskFieldValueUpdateInputRepresentation
+      taskId:
+        description: Task Id
+        type: string
+  ActionPlanTaskFieldValueUpdateInputRepresentation:
+    description: Input representation for Action Plan Task Field edited
+    type: object
+    properties:
+      fieldApiName:
+        description: Field Api Name
+        type: string
+      fieldValue:
+        description: Field Value
+        type: string
+  ActionPlanUpdateOutputRepresentation:
+    description: Output representation for update of Action Plan Tasks
+    type: object
+    properties:
+      actionPlanId:
+        description: Action Plan  Id of the updated items
+        type: string
+      errors:
+        description: Action Plan Task Update Errors
+        type: array
+        items:
+          type: ActionPlanUpdateErrorOutputRepresentation
+      message:
+        description: Update Message
+        type: string | nil
+      status:
+        description: Update status
+        type: string
+  ActionPlanUpdateErrorOutputRepresentation:
+    description: 'Output representation for errors during update of Action Plan Tasks '
+    type: object
+    properties:
+      errorMessageList:
+        description: Error list during the update of action plan task
+        type: array
+        items:
+          type: string
+      taskId:
+        description: Task Id
+        type: string
+/connect/action-plan-template-version/{actionPlanTemplateVersionId}:
+  get:
+    description: API to fetch the ActionPlanTemplateItems and their Labels
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ActionPlanTemplateItemsLabelOutputRepresentation
+    queryParameters:
+      limit:
+        type: integer
+        required: false
+  uriParameters:
+    actionPlanTemplateVersionId:
+      type: string
+      required: true
+/connect/action-plan:
+  get:
+    description: API to get the action plans configured for the context Object
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ActionPlansWrapperOutputRepresentation
+    queryParameters:
+      actionPlanType:
+        type: string
+        required: false
+        enum:
+          - Industries
+          - Retail
+      limit:
+        type: integer
+        required: false
+      order:
+        type: string
+        required: false
+        enum:
+          - Asc
+          - Desc
+      orderingParam:
+        type: string
+        required: false
+        enum:
+          - ActualEndDate
+          - ActualStartDate
+          - CreatedDate
+          - EndDate
+          - Id
+          - LastItemActionDateTime
+          - LastModifiedDate
+          - LastReferencedDate
+          - LastViewedDate
+          - Name
+          - StartDate
+          - StatusCode
+      targetId:
+        type: string
+        required: false
+  /{actionPlanId}:
+    /action-plan-items:
+      get:
+        description: API to fetch data of ServicePlanTemplateId and it's related record
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ActionPlanItemsWrapperRepresentation
+        queryParameters:
+          limit:
+            type: integer
+            required: false
+      uriParameters:
+        actionPlanId:
+          type: string
+          required: true
+    /status-info:
+      get:
+        description: API to get the aggregated status of Action Plan Items, whether
+          all mandatory items are completed
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ActionPlanStatusInfoOutputRepresentation
+      uriParameters:
+        actionPlanId:
+          type: string
+          required: true
+/connect/action-plan-template-update/{actionPlanTemplateVersionId}:
+  patch:
+    description: Patch Resource method to edit ActionPlanTemplate Tasks
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ActionPlanTemplateUpdateOutputRepresentation
+    body:
+      application/json:
+        type: ActionPlanTemplateUpdateInputRepresentation
+        (oas-body-name): actionPlanTemplateUpdateInput
+  uriParameters:
+    actionPlanTemplateVersionId:
+      type: string
+      required: true
+/connect/action-plan-update/{actionPlanId}:
+  patch:
+    description: Patch Resource method to edit ActionPlan Tasks
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ActionPlanUpdateOutputRepresentation
+    body:
+      application/json:
+        type: ActionPlanUpdateInputRepresentation
+        (oas-body-name): actionPlanUpdateInput
+  uriParameters:
+    actionPlanId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,63 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'ActionPlan'
+
+types:
+  ActionPlanStatusInfoOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ActionPlanItemsWrapperRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ActionPlansWrapperOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ActionPlanTemplateItemsLabelOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  ActionPlanTemplateUpdateOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: actionPlanTemplateVersionId
+  ActionPlanUpdateOutputRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: actionPlanId
+
+/connect/action-plan-template-update/{actionPlanTemplateVersionId}:
+  patch:
+    (luvio.adapter):
+      name: updateActionPlanTemplateTasks
+/connect/action-plan-update/{actionPlanId}:
+  patch:
+    (luvio.adapter):
+      name: updateActionPlanTasks
+/connect/action-plan-template-version/{actionPlanTemplateVersionId}:
+  get:
+    (luvio.adapter):
+      name: getActionPlanTemplateItemsLabel
+/connect/action-plan:
+  get:
+    (luvio.adapter):
+      name: getActionPlans
+  /{actionPlanId}:
+    /action-plan-items:
+      get:
+        (luvio.adapter):
+          name: getActionPlanItems
+    /status-info:
+      get:
+        (luvio.adapter):
+          name: getActionPlanStatusInfo
+          tests:
+            validConfigs:
+              - |
+                {
+                  "actionPlanId": "07rxx0000004CDsAAM"
+                }