@salesforce/lds-adapters-industries-externaldocument 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,225 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  ExternalDocCreationInputRepresentation:
+    description: Input representation to Create External Document
+    type: object
+    properties:
+      contentVersionId:
+        description: Content Version Id of the document using which new external document
+          has to be created
+        type: string
+      documentNamePrefix:
+        description: Document Name prefix which is required to name the newly created
+          external document
+        type: string
+      isAsync:
+        description: Determines the way the external document get created
+        type: string
+      refObjectId:
+        description: Id of the reference Object. It would be either Document Template
+          or Contract ID
+        type: string
+  ExternalDocCreationOutputRepresentation:
+    description: Output representation for Create External Document
+    type: object
+    properties:
+      externalDocumentDetails:
+        description: External Document Storage information
+        type: object
+      isSuccess:
+        description: Boolean flag determines if the api is Success
+        type: boolean
+      message:
+        description: Provides a description of the error message in case of failure
+        type: string
+      ssoLinkUrl:
+        description: Provides a description of the error message in case of failure
+        type: string
+  ExternalDocumentMetadataRepresentation:
+    description: Input representation of external document metadata
+    type: object
+    properties:
+      objectReferences:
+        description: ObjectReferences List
+        type: array
+        items:
+          type: object
+      sections:
+        description: Section List
+        type: array
+        items:
+          type: object
+  ExternalDocumentOutputRepresentation:
+    description: Output representation for External Document
+    type: object
+    properties:
+      contentVersionId:
+        description: The ID for the Salesforce Content Version
+        type: string
+      externalDocumentId:
+        description: The ID for the external document
+        type: string
+      externalUserId:
+        description: The ID for the external user
+        type: string
+      referenceObject:
+        description: The api name for Salesforce Reference Object
+        type: string
+      referenceObjectId:
+        description: The ID for the Salesforce Reference Object
+        type: string
+      url:
+        description: The url to access the external document
+        type: string
+  ObjectReferenceRepresentation:
+    description: Input representation of objectReference
+    type: object
+    properties:
+      objectId:
+        description: ObjectId
+        type: string
+      objectType:
+        description: ObjectType
+        type: string
+      usages:
+        description: Usages
+        type: object
+  SaveExternalDocumentInputRepresentation:
+    description: Input representation to save external document to salesforce
+    type: object
+    properties:
+      externalDocumentId:
+        description: External Document ID
+        type: string
+      isAsync:
+        description: Is Async
+        type: boolean
+      metadata:
+        description: Metadata
+        type: object
+  SaveExternalDocumentRepresentation:
+    description: Output representation for Save External Document
+    type: object
+    properties:
+      id:
+        description: The ID for the external document
+        type: string
+      isSuccess:
+        description: The isSuccess flag for SaveExternalDocument
+        type: boolean
+      message:
+        description: The response message for SaveExternalDocument
+        type: string
+        required: false
+  SectionRepresentation:
+    description: Input representation of a section
+    type: object
+    properties:
+      guid:
+        description: GUID
+        type: string
+      isReadonly:
+        description: IsReadonly
+        type: boolean
+      name:
+        description: Name
+        type: string
+  UsagesRepresentation:
+    description: Input representation of usages
+    type: object
+    properties:
+      sectionIds:
+        description: Section GUIDs
+        type: array
+        items:
+          type: string
+      usedInDocument:
+        description: UsedInDocument
+        type: boolean
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps
+  ExternalDocCreationInputRepresentationWrapper:
+    description: Wrapper for ExternalDocCreationInputRepresentation
+    type: object
+    properties:
+      createExternalDocumentInput:
+        type: ExternalDocCreationInputRepresentation
+        description: Input representation to get external document creation
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps
+  SaveExternalDocumentInputRepresentationWrapper:
+    description: Wrapper for SaveExternalDocumentInputRepresentation
+    type: object
+    properties:
+      saveExternalDocumentInput:
+        type: SaveExternalDocumentInputRepresentation
+        description: Input representation to save external document update
+/connect/external-document:
+  get:
+    description: Get the external document to salesforce
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ExternalDocumentOutputRepresentation
+    queryParameters:
+      externalDocumentId:
+        type: string
+        required: false
+      refObjectId:
+        type: string
+        required: false
+  patch:
+    description: Saves the external document to salesforce
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SaveExternalDocumentRepresentation
+    body:
+      application/json:
+        # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+        type: SaveExternalDocumentInputRepresentationWrapper
+        # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+        # required: false
+        (oas-body-name): saveExternalDocumentInput
+  post:
+    description: Create a new External Document
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: ExternalDocCreationOutputRepresentation
+    body:
+      application/json:
+        # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+        type: ExternalDocCreationInputRepresentationWrapper
+        # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+        # required: false
+        (oas-body-name): createExternalDocumentInput

package/src/raml/luvio.raml

@@ -0,0 +1,55 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+uses:
+  luvio: luvio://annotations.raml
+(luvio.keyPrefix): 'ExternalDocument'
+(luvio.ttl): 360000
+types:
+  ExternalDocCreationInputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ExternalDocumentMetadataRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  ObjectReferenceRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  SaveExternalDocumentInputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  SectionRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  UsagesRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+  SaveExternalDocumentRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  ExternalDocCreationOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+    (luvio.key):
+      isSuccess: isSuccess
+  ExternalDocumentOutputRepresentation:
+    (luvio.ttl): 60000
+    (luvio.opaque): true
+/connect/external-document:
+  get:
+    (luvio.adapter):
+      name: getExternalDocument
+    queryParameters:
+      externalDocumentId:
+        type: string
+        required: false
+      refObjectId:
+        type: string
+        required: false
+  post:
+    (luvio.adapter):
+      name: createExternalDocument
+  patch:
+    (luvio.adapter):
+      name: saveExternalDocument