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

package/src/raml/luvio.raml

@@ -0,0 +1,273 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+uses:
+  luvio: luvio://annotations.raml
+(luvio.keyPrefix): 'docgen'
+(luvio.ttl): 360000
+types:
+  EnvelopeSendResponse:
+    (luvio.key):
+      envelopeId: envelopeId
+  SignerRolesResponse:
+    (luvio.ttl): 60000
+  RecipientListResponse:
+    (luvio.ttl): 60000
+  NotificationSettingResponse:
+    (luvio.ttl): 60000
+  DocumentListResponse:
+    (luvio.ttl): 60000
+  EnvelopeStatusListResponse:
+    (luvio.key):
+      sourceObjectId: sourceObjectId
+  EnvelopeVoidResponse:
+    (luvio.key):
+      sourceObjectId: sourceObjectId
+  EnvelopeSendRequest:
+    (luvio.opaque): true
+  ClauseCategoriesResponse:
+    (luvio.ttl): 30000
+  DocumentClauseSetListResponse:
+    (luvio.ttl): 100
+  DocumentClauseFieldsResponse:
+    (luvio.ttl): 100
+  GenericOutputRepresentation:
+    (luvio.key):
+      id: id
+  DocumentTemplateRepresentation:
+    (luvio.key):
+      documentTemplateId: documentTemplateId
+  DocumentTemplateUpdateInputRepresentation:
+    (luvio.opaque): true
+  DocumentTemplateRequest:
+    (luvio.opaque): true
+  DocumentTemplateListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  DocumentClausePromotionResponse:
+    (luvio.ttl): 60000
+    (luvio.key):
+      isSuccess: isSuccess
+  DocumentClausePromotionRequest:
+    (luvio.ttl): 60000
+  DocumentCompareOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      compareDocumentId: compareDocumentId
+  ContentLinkListRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      referenceObjectId: referenceObjectId
+  DocPreviewOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      fileId: fileId
+  DocGenConfigOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      status: status
+  ContentLinkDataSyncOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.key):
+      referenceObjectId: referenceObjectId
+/connect:
+  /docgen:
+    /doc-generation-batch-process/{docGenerationBatchProcessId}/{actionName}:
+      patch:
+        (luvio.adapter):
+          name: performDocGenerationBatchProcessAction
+      uriParameters:
+        docGenerationBatchProcessId:
+        actionName:
+    /document-templates:
+      get:
+        (luvio.adapter):
+          name: getDocumentTemplates
+        queryParameters:
+          cloneOnly:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          limit:
+            type: string
+            required: false
+          offset:
+            type: string
+            required: false
+          searchString:
+            type: string
+            required: false
+          type:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          usageType:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      patch:
+        (luvio.adapter):
+          name: updateDocumentTemplate
+        queryParameters:
+          documentTemplateId:
+            type: string
+            required: false
+      post:
+        (luvio.adapter):
+          name: createDocumentTemplate
+        queryParameters:
+          action:
+            type: string
+            required: false
+          documentTemplateId:
+            type: string
+            required: false
+    /document-compare:
+      post:
+        (luvio.adapter):
+          name: createComparisonDocument
+    /document/preview:
+      post:
+        (luvio.adapter):
+          name: getDocumentPreview
+    /config:
+      post:
+        (luvio.adapter):
+          name: getDocGenConfig
+  /e-sign:
+    /documents:
+      get:
+        (luvio.adapter):
+          name: getDocuments
+        queryParameters:
+          documentSelector:
+            type: string
+            required: false
+          sourceObjectId:
+            type: string
+            required: false
+    /signer-roles:
+      get:
+        (luvio.adapter):
+          name: getSignerRoles
+    /recipients:
+      get:
+        (luvio.adapter):
+          name: getRecipients
+          tests:
+            validConfigs:
+              - |
+                {
+                }
+          queryParameters:
+            recipientSelector:
+              type: string
+              required: false
+            sourceObjectId:
+              type: string
+              required: false
+    /notification-settings:
+      get:
+        (luvio.adapter):
+          name: getESignNotificationSettings
+        queryParameters:
+          sourceObjectId:
+    /signature-requests/{sourceObjectId}:
+      /envelope/send:
+        post:
+          (luvio.adapter):
+            name: createDocumentEnvelopeForEsign
+        uriParameters:
+          sourceObjectId:
+      /envelopes:
+        /status:
+          patch:
+            (luvio.adapter):
+              name: updateEnvelope
+          uriParameters:
+            sourceObjectId:
+        /void:
+          patch:
+            (luvio.adapter):
+              name: updateVoidedEnvelope
+          uriParameters:
+            sourceObjectId:
+  /clause-library:
+    /clause-category-configurations:
+      get:
+        (luvio.adapter):
+          name: getDocumentClauseSetCategories
+        queryParameters:
+          id:
+            type: string
+            required: false
+          name:
+            type: string
+            required: false
+          usageType:
+            type: string
+            required: false
+    /document-clause-sets:
+      get:
+        (luvio.adapter):
+          name: getDocumentClauseSets
+        queryParameters:
+          category:
+            type: string
+            required: false
+          defaultLanguage:
+            type: string
+            required: false
+          limit:
+            type: integer
+            required: false
+          name:
+            type: string
+            required: false
+          offset:
+            type: integer
+            required: false
+          status:
+            type: string
+            required: false
+    /document-clauses/fields:
+      get:
+        (luvio.adapter):
+          name: getDocumentClauseFields
+        queryParameters:
+          clauseSetId:
+            type: string
+            required: false
+          extendedFields:
+            type: string
+            required: false
+          fieldName:
+            type: string
+            required: false
+          language:
+            type: string
+            required: false
+          name:
+            type: string
+            required: false
+          status:
+            type: string
+            required: false
+    /promote-clause:
+      post:
+        (luvio.adapter):
+          name: postDocumentClausePromotion
+  /content-link:
+    /load:
+      post:
+        (luvio.adapter):
+          name: getContentLinkInput
+    /data-sync:
+      post:
+        (luvio.adapter):
+          name: getContentLinkDataSyncDetails