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

package/src/raml/luvio.raml

@@ -0,0 +1,341 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+uses:
+  luvio: luvio://annotations.raml
+(luvio.keyPrefix): 'clm'
+(luvio.ttl): 360000
+types:
+  ContractDocumentVersionCCRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractId: contractId
+  ContractDocumentVersionsListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  GenericOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  TemplateListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ContractDocumentVersionRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractDocumentVersionId: contractDocumentVersionId
+      contractId: contractId
+  ContentDocumentListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractDocumentVersionId: contractDocumentVersionId
+  DocumentGenerateRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractId: contractId
+  ContractActionListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractId: contractId
+  ContractActionRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  SaveExternalDocumentRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  ContractDocumentVersionReviewInputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ContractDocumentVersionReviewOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractDocumentVersionId: contractDocumentVersionId
+  ContractDocumentVersionReviewerInputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ContractDocumentVersionReviewerOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ContractDocumentVersionReviewersListOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      contractDocumentVersionId: contractDocumentVersionId
+  DocumentRecipientStatusCCRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ExternalDocumentReviewCCRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ExtractionContextMappingInputRepresentation:
+    (luvio.ttl): 60000
+  ExtractionContextMappingOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      contextUseCaseMappingId: contextUseCaseMappingId
+  ExtractionContextMappingRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      id: id
+  ExtractionContextMappingsOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      id: id
+  ExtractionContextUseCaseMappingInputRepresentation:
+    (luvio.ttl): 60000
+  ExtractionContextUseCaseMappingRepresentation:
+    (luvio.ttl): 60000
+
+/connect:
+  /clm:
+    /cc:
+      /contract/{contractId}/contract-document-version:
+        get:
+          (luvio.adapter):
+            name: getLatestContractDocumentVersionCC
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "contractId": "0qtRO00000000FQYAY"
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "contractId": {}
+                  }
+          (luvio.key):
+            contractId: urlParams.contractId
+          queryParameters:
+            showDetails:
+              type: boolean
+              required: false
+        uriParameters:
+          contractId:
+      /documentRecipient:
+        get:
+          (luvio.adapter):
+            name: getDocumentRecipientAndStatus
+          queryParameters:
+            contractDocumentVersionId:
+              type: string
+              required: false
+      /external-document:
+        get:
+          (luvio.adapter):
+            name: getExternalDocumentReviewCC
+          queryParameters:
+            contractDocumentVersionId:
+              type: string
+              required: false
+    /contract-document-version/{contractDocumentVersionId}:
+      patch:
+        (luvio.adapter):
+          name: updateContractDocumentVersionWithTemplate
+      uriParameters:
+        contractDocumentVersionId:
+      /checkIn:
+        patch:
+          (luvio.adapter):
+            name: checkIn
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "contractDocumentVersionId": "1"
+                  }
+          description: CheckIn a Contract Document Version using Contract Document Version ID
+        uriParameters:
+          contractDocumentVersionId:
+      /checkout:
+        post:
+          (luvio.adapter):
+            name: checkoutContractDocumentVersion
+        uriParameters:
+          contractDocumentVersionId:
+      /content-documents:
+        delete:
+          (luvio.adapter):
+            name: deleteAttachment
+          queryParameters:
+            contentDocumentId:
+          (luvio.key):
+            contractDocumentVersionId: urlParams.contractDocumentVersionId
+        patch:
+          (luvio.adapter):
+            name: updateSharingOnAttachment
+            tests:
+              validConfigs:
+                - |
+                  {
+                    "contractDocumentVersionId": "0qtRO00000000FQYAY",
+                    "contentDocumentId": "069RO00000027elYAA",
+                    "share": true
+                  }
+                - |
+                  {
+                    "contractDocumentVersionId": "0qtRO00000000FQYAY",
+                    "contentDocumentId": "069RO00000027elYAA",
+                    "share": false
+                  }
+              invalidConfigs:
+                - |
+                  {
+                    "contractDocumentVersionId": {},
+                    "contentDocumentId": "069RO00000027elYAA"
+                  }
+                - |
+                  {
+                    "contractDocumentVersionId": {},
+                    "contentDocumentId": {}
+                  }
+          queryParameters:
+            contentDocumentId:
+              type: string
+              required: false
+            share:
+              type: boolean
+              required: false
+        get:
+          (luvio.adapter):
+            name: getContentDocument
+          (luvio.key):
+            contractDocumentVersionId: urlParams.contractDocumentVersionId
+        uriParameters:
+          contractDocumentVersionId:
+      /lock:
+        patch:
+          (luvio.adapter):
+            name: lockContractDocumentVersion
+        uriParameters:
+          contractDocumentVersionId:
+      /unlock:
+        patch:
+          (luvio.adapter):
+            name: unlock
+          description: Unlock a Contract Document Version using Contract Document Version ID
+        uriParameters:
+          contractDocumentVersionId:
+      /review:
+        delete:
+          (luvio.adapter):
+            name: deleteContractDocumentVersionReview
+          (luvio.key):
+            contractDocumentVersionId: urlParams.contractDocumentVersionId
+        get:
+          (luvio.adapter):
+            name: getContractDocumentVersionReview
+          (luvio.key):
+            contractDocumentVersionId: urlParams.contractDocumentVersionId
+        patch:
+          (luvio.adapter):
+            name: updateContractDocumentVersionReview
+        post:
+          (luvio.adapter):
+            name: createContractDocumentVersionReview
+        uriParameters:
+          contractDocumentVersionId:
+      /externalReviewDocument:
+        post:
+          (luvio.adapter):
+            name: createExternalReviewDocument
+        uriParameters:
+          contractDocumentVersionId:
+    /contract/{contractId}/contract-document-version:
+      get:
+        (luvio.adapter):
+          name: getContractDocumentVersion
+          tests:
+            validConfigs:
+              - |
+                {
+                  "contractId": "12AASKASSKKAS3QQ"
+                }
+        queryParameters:
+          contractDocumentVersionId:
+      post:
+        (luvio.adapter):
+          name: createContractDocumentVersionAndInitializeGenerateDocumentProcess
+      uriParameters:
+        contractId:
+    /document-template:
+      get:
+        (luvio.adapter):
+          name: getTemplates
+        queryParameters:
+          isActive:
+            type: boolean
+            required: false
+          type:
+            type: string
+            required: false
+          usageType:
+            type: string
+            required: false
+          contractId:
+            type: string
+            required: false
+          documentTemplateTypes:
+            type: array
+            required: false
+            items:
+              type: string
+              enum:
+                - MicrosoftPowerpoint
+                - MicrosoftWord
+                - MicrosoftWordOnline
+                - Web
+              (oas-collectionFormat): csv
+    /document-generation-process/status:
+      get:
+        (luvio.adapter):
+          name: getDocumentGenerationProcessDetails
+        queryParameters:
+          contractDocumentVersionId:
+    /contract/{contractId}:
+      patch:
+        (luvio.adapter):
+          name: executeContractAction
+      uriParameters:
+        contractId:
+      /contract-actions:
+        get:
+          (luvio.adapter):
+            name: getContractActions
+          (luvio.key):
+            contractId: urlParams.contractId
+        uriParameters:
+          contractId:
+    /external-document-resource:
+      patch:
+        (luvio.adapter):
+          name: saveExternalDocument
+        description: Save an external document to salesforce
+    /extraction-context-mappings:
+      post:
+        (luvio.adapter):
+          name: createExtractionContextMapping
+    /extraction-context-mappings/{contextUseCaseMappingId}:
+      delete:
+        (luvio.adapter):
+          name: deleteExtractionContextMapping
+        (luvio.key):
+          contextUseCaseMappingId: urlParams.contextUseCaseMappingId
+      get:
+        (luvio.adapter):
+          name: getExtractionContextMapping
+        (luvio.key):
+          contextUseCaseMappingId: urlParams.contextUseCaseMappingId
+      patch:
+        (luvio.adapter):
+          name: updateExtractionContextMapping
+      uriParameters:
+        contextUseCaseMappingId: