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

package/src/raml/api.raml

@@ -0,0 +1,122 @@
+#%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:
+  DecisionTableDocumentDecisionRepresentation:
+    description: Output represenation of for Document Matrix
+    type: object
+    properties:
+      defaultMaximumFileSizeAllowed:
+        description: The default value for maximumFileSizeAllowed when its value is
+          null in documentTypes output fields.
+        type: string
+      defaultMaximumFileUploadsAllowed:
+        description: The default value for maximumFileUploadsAllowed when its value
+          is null in documentTypes output fields.
+        type: string
+      documentCategoryId:
+        description: The Id of DocumentCategory given as an output of Decision Table
+        type: string
+      documentCategoryLabel:
+        description: The Master Label of DocumentCategory given as an output of Decision
+          Table
+        type: string
+      documentTypes:
+        description: The document types associated with document category OR given
+          as output of Decision Table
+        type: array
+        items:
+          type: DocumentTypesRepresentation
+      helpText:
+        description: Helptext for document Category uploads.
+        type: string
+      isRequired:
+        description: Represents if upload for the document category is required or
+          not.
+        type: boolean
+  DocumentDecisionInputRepresentation:
+    description: Input representation for the connect api
+    type: object
+    properties:
+      inputs:
+        description: List of inputs passed to Decision Table. The key should contain
+          field name of Decision table and value should contain value of the field
+          that is the key. An input may contain multiple fields.
+        type: any
+  DocumentDecisionResponseRepresentation:
+    description: Output representation of Document Matrix Decision
+    type: object
+    properties:
+      decisionTableDocumentDecisions:
+        description: The flat data of Decision Table Output.
+        type: array
+        items:
+          type: DecisionTableDocumentDecisionRepresentation
+      message:
+        description: The message explaining why the request failed.
+        type: string
+      status:
+        description: Indicates whether the request succeeded (true) or failed (false).
+        type: string
+  DocumentTypesRepresentation:
+    description: Output representation of Document Type
+    type: object
+    properties:
+      documentTypeId:
+        description: The Id of Document Type that is associated with document category
+        type: string
+      documentTypeLabel:
+        description: The label of Document Type that is associated with document category
+        type: string
+      maximumFileSizeAllowed:
+        description: 'Maximum file size in KBs for a file that can be uploaded for
+          a document type '
+        type: string
+      maximumFileUploadsAllowed:
+        description: 'Maximum file uploads that can be uploaded for a document type '
+        type: string
+/connect/document-matrix/document-decision/{decisionTableId}:
+  post:
+    displayName: postDocumentMatrix
+    description: Get Document Decision data
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: DocumentDecisionResponseRepresentation
+    body:
+      application/json:
+        description: List of inputs passed to Decision Table. The key should contain
+          field name of Decision table and value should contain value of the field
+          that is the key. An input may contain multiple fields.
+        type: DocumentDecisionInputRepresentation
+        (oas-body-name): inputs
+  uriParameters:
+    decisionTableId:
+      description: The Id of Decision Table to be used for decision making.
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,19 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'DocumentMatrix'
+(luvio.ttl): 3600000
+
+types:
+  DocumentDecisionResponseRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+
+/connect/document-matrix/document-decision/{decisionTableId}:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: getDocumentDecision