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

package/src/raml/api.raml

@@ -0,0 +1,354 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.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:
+  AssessmentContextSearchInputRepresentation:
+    description: Assessment context search input
+    type: object
+    properties:
+      derivedFilters:
+        description: List of Derived Filters that needs to be used to fetch Data
+        type: array
+        items:
+          type: object
+      filterCriteria:
+        description: List of filter criteria to be applied.
+        type: array
+        items:
+          type: object
+      recordCount:
+        description: Number of records to return.  Defaults to 20 records.
+        type: integer | nil
+      recordOffsets:
+        description: List of record offsets.
+        type: array
+        items:
+          type: object
+      sortOptions:
+        description: List of sort options in the order the resultset needs to be sorted.
+        type: array
+        items:
+          type: object
+  AssessmentContextSearchWrapperInputRepresentation:
+    description: wrapper of AssessmentContextSearchInputRepresentation
+    type: object
+    properties:
+      AssessmentContextSearchData:
+        description: Input representation for AssessmentContextSearchInputRepresentation
+        type: AssessmentContextSearchInputRepresentation
+  AssessmentContextSearchResultRepresentation:
+    description: Assessment search completed successfully.
+    type: object
+    properties:
+      hasMoreRecords:
+        description: true if there are more records to fetch.  false if it is the
+          last page.
+        type: boolean
+      isSuccess:
+        description: true if successful and false if there is a failure
+        type: boolean
+      message:
+        description: If isSuccess is false, there can be one or more error messages.  If
+          isSuccess is true, message will be empty.
+        type: string  | nil
+      recordOffsets:
+        description: List of record offsets based on which the records were queried.  The
+          offsets are returned back to the client for the client to provide this information
+          next time to get subsequent pages.
+        type: array
+        items:
+          type: RecordOffsetRepresentation
+      records:
+        description: List of records returned back by the API
+        type: array
+        items:
+          type: RecordsRepresentation
+  AssessmentEnvelopeItemsListRepresentation:
+    description: List of assessment envelope items
+    type: object
+    properties:
+      id:
+        description: Assessment envelope item record id
+        type: string | nil
+  AssessmentEnvelopeWrapperInputRepresentation:
+    description: wrapper for AssessmentEnvelopeInputRepresentation
+    type: object
+    properties:
+      AssessmentEnvelopeData:
+        description: Input representation for AssessmentEnvelopeInputRepresentation
+        type: AssessmentEnvelopeInputRepresentation
+  AssessmentEnvelopeInputRepresentation:
+    description: Assessment envelope input
+    type: object
+    properties:
+      account:
+        description: Account of the assessment envelope
+        type: string | nil
+        required: false
+      assessmentEnvelopeItems:
+        description: List of assessment envelope items associated to the assessment
+          envelope
+        type: array
+        items:
+          type: object
+      contact:
+        description: Contact of the assessment envelope
+        type: string | nil
+        required: false
+      expirationDateTime:
+        description: Expiration datetime of the assessment envelope
+        type: string | nil
+      name:
+        description: Name of the assessment envelope
+        type: string | nil
+      requestReference:
+        description: Request context of the assessment envelope
+        type: string  | nil
+        required: false
+      status:
+        description: Status of the assessment envelope
+        type: string | nil
+  AssessmentEnvelopeItemsRepresentation:
+    description: List of assessment envelope items associated to the assessment envelope
+    type: object
+    properties:
+      name:
+        description: Name of the assessment envelope item
+        type: string | nil
+      omniProcess:
+        description: OmniProcess record id of the assessment envelope item
+        type: string | nil
+      status:
+        description: Status of the assessment envelope item
+        type: string | nil
+  AssessmentEnvelopeRepresentation:
+    description: Assessment envelope response
+    type: object
+    properties:
+      assessmentEnvelopeItems:
+        description: List of assessment envelope items
+        type: array
+        items:
+          type: AssessmentEnvelopeItemsListRepresentation
+      id:
+        description: Assessment envelope record id
+        type: string | nil
+  AssessmentEnvelopeGetResultRepresentation:
+    description: Output representation of Assessment envelope from the GET Resource
+    type: object
+    properties:
+      assessmentEnvelope:
+        description: Assessment envelope response
+        type: AssessmentEnvelopeOutputRepresentation
+      isSuccess:
+        description: true if successful and false if there is a failure
+        type: boolean
+      message:
+        description: If isSuccess is false, there can be one or more error messages.  If
+          isSuccess is true, message will be empty.
+        type: string
+  AssessmentEnvelopeOutputRepresentation:
+    description: Output representation of Assessment envelope from the GET Resource
+    type: object
+    properties:
+      assessmentEnvelopeItems:
+        description: List of assessment envelope items
+        type: array
+        required: false
+        items:
+          type: AssessmentEnvelopeItemsListOutputRepresentation
+      expirationDateTime:
+        description: Assessment envelope expiration datetime
+        type: string
+        required: false
+      id:
+        description: Assessment envelope record id
+        type: string
+      status:
+        description: Assessment envelope status
+        type: string
+  AssessmentEnvelopeItemsListOutputRepresentation:
+    description: Output representation of list of assessment envelope items
+    type: object
+    properties:
+      id:
+        description: Assessment envelope item record id
+        type: string
+        required: false
+      omniProcessId:
+        description: Assessment envelope item omniprocess
+        type: string
+        required: false
+      status:
+        description: Assessment envelope item status
+        type: string
+  AssessmentEnvelopeResultRepresentation:
+    description: Assessment Envelope created successfully
+    type: object
+    properties:
+      assessmentEnvelope:
+        description: Assessment envelope response
+        type: AssessmentEnvelopeRepresentation
+      isSuccess:
+        description: true if successful and false if there is a failure
+        type: boolean
+      message:
+        description: If isSuccess is false, there can be one or more error messages.  If
+          isSuccess is true, message will be empty.
+        type: string  | nil
+  DerivedFiltersInputRepresentation:
+    description: Assessment context search - Derived Filters
+    type: object
+    properties:
+      derivedFilterName:
+        description: Set the Name of the Derived Filters
+        type: string
+      derivedFilterValue:
+        description: 'Set the value of the derived Filters : True or False'
+        type: boolean
+  FilterCriteriaRepresentation:
+    description: Filter criteria to be applied.
+    type: object
+    properties:
+      columnName:
+        description: Name of the column.  Validation will be performed based on the
+          list of allowed column names.
+        type: string | nil
+      operator:
+        description: Operation to be performed for the query criteria.  Supported
+          operators are =, <=, >=, LIKE
+        type: string
+        enum:
+          - Equal
+          - GreaterThan
+          - GreaterThanOrEqual
+          - In
+          - LessThan
+          - LessThanOrEqual
+          - Like
+          - NotIn
+      values:
+        description: Values based on which the filter will be applied
+        type: array
+        items:
+          type: string | nil
+  RecordOffsetRepresentation:
+    description: Record offset.
+    type: object
+    properties:
+      offsetName:
+        description: Offset name that is mapped to a resultset.  We will have list
+          of allowed offset names
+        type: string | nil
+        enum:
+          - AssessmentEnvelopeResult
+          - AssessmentResult
+      value:
+        description: Value of the offset
+        type: integer | nil
+  RecordsRepresentation:
+    description: Records returned back by the API
+    type: object
+    properties:
+      assessmentEnvelopeId:
+        description: A unique identifier of the assessment envelope record.
+        type: string | nil
+      assessmentEnvelopeItemId:
+        description: A unique identifier of the assessment envelope item record.
+        type: string | nil
+      assessmentId:
+        description: A unique identifier of the assessment record.
+        type: string | nil
+      derivedStatus:
+        description: Derived Status
+        type: string | nil
+        enum:
+          - Complete
+          - Expired
+          - NotStarted
+      omniProcessId:
+        description: A unique identifier of the omni process record.
+        type: string | nil
+  SortOptionRepresentation:
+    description: Sort option in the order the resultset needs to be sorted.
+    type: object
+    properties:
+      columnName:
+        description: Name of the column.  Validation will be performed based on the
+          list of allowed column names.
+        type: string | nil
+      sortBy:
+        description: Ascending or Descending - sort option based on which the sort
+          will be performed
+        type: string | nil
+        enum:
+          - Ascending
+          - Descending
+/connect:
+  /assessments:
+    /assessmentenvelopes:
+      post:
+        description: Create assessment envelope, assessment envelope item records
+          and return record ids
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AssessmentEnvelopeResultRepresentation
+        body:
+          application/json:
+            type: AssessmentEnvelopeWrapperInputRepresentation
+            (oas-body-name): AssessmentEnvelopeData
+      get:
+        description: Get a list of assessment envelope items associated to an envelope.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AssessmentEnvelopeGetResultRepresentation
+        queryParameters:
+          signature:
+            type: string
+    /{contextId}/assessment-elements:
+      post:
+        description: Search for assessment records and return the matched records
+          with the record id as the reference
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AssessmentContextSearchResultRepresentation
+        body:
+          application/json:
+            type: AssessmentContextSearchWrapperInputRepresentation
+            (oas-body-name): AssessmentContextSearchData
+      uriParameters:
+        contextId:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,41 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'assessment'
+(luvio.ttl): 6000
+
+types:
+  AssessmentContextSearchResultRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+  AssessmentEnvelopeResultRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+  AssessmentEnvelopeGetResultRepresentation:
+    (luvio.key):
+      assessmentEnvelopeId: assessmentEnvelope.id
+    (luvio.updateAvailable):
+      name: notifyAssessmentUpdateAvailable
+      parameters:
+        assessmentEnvelopeId: assessmentEnvelope.id
+    (luvio.opaque): true
+    (luvio.ttl): 6000
+
+/connect/assessments/{contextId}/assessment-elements:
+  post:
+    (luvio.adapter):
+      name: postAssessmentContextSearch
+/connect/assessments/assessmentenvelopes:
+  post:
+    (luvio.adapter):
+      name: postAssessmentEnvelope
+  get:
+    (luvio.adapter):
+      name: getAssessmentEnvelope
+    (luvio.key):
+      assessmentEnvelopeId: queryParams.signature
+    queryParameters:
+      signature: