@salesforce/lds-adapters-industries-clm 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,649 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  ContentDocumentListRepresentation:
+    description: ContentDocument record list
+    type: object
+    properties:
+      contractDocumentVersionId:
+        description: ContractDocumentVersion ID for which list of ContentDocuments
+          fetched
+        type: string
+      data:
+        description: List of ContentDocument details associated to the ContractDocumentVersion
+        type: array
+        required: false
+        items:
+          type: ContentDocumentRepresentation
+  ContentDocumentRepresentation:
+    description: ContentDocument record
+    type: object
+    properties:
+      contentDocumentId:
+        description: The record Id of ContentDocument
+        type: string
+      contentDocumentLinkId:
+        description: The record Id of ContentDocumentLink
+        type: string
+        required: false
+      contractDocumentVersionId:
+        description: The record Id of the linked ContractDocumentVersion object
+        type: string
+      createdDate:
+        description: The createdDate of ContentDocument
+        type: string
+      fileExtension:
+        description: The fileExtension of ContentDocument
+        type: string
+        required: false
+      lastModifiedDate:
+        description: The lastModifiedDate of ContentDocument
+        type: string
+      title:
+        description: The title of ContentDocument
+        type: string
+  ContractActionInputRepresentation:
+    description: Input representation to get action details for the contract
+    type: object
+    properties:
+      actionApiName:
+        description: API name for respective contract action
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      actionData:
+        description: action body with supported format string, string for contract
+          action
+        type: object
+        properties:
+          //:
+            type: string
+        required: false # TODO Hand-rolled W-9314597
+      actionId:
+        description: action Id for the respective Contract action
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  ContractActionListRepresentation:
+    description: Output representation of Contract Actions
+    type: object
+    properties:
+      actions:
+        description: The list of actions
+        type: array
+        items:
+          type: ContractActionRepresentation
+      contractId:
+        description: contract Id
+        type: string
+  ContractActionRepresentation:
+    description: Contract Actions
+    type: object
+    properties:
+      apiName:
+        description: The api name for the action
+        type: string
+      uiText:
+        description: The localized text for the action
+        type: string
+      actionType:
+        description: Action type for state action object, whether it's Apex or Reference Object
+        type: string
+        required: false
+      actionId:
+        description: Id for the Object State Action Definition
+        type: string
+        required: true
+      invocableClassName:
+        description: The name of Apex invocable class
+        type: string
+        required: false
+      invocableMethodName:
+        description: The name of Apex invocable class method
+        type: string
+        required: false
+      referenceObject:
+        description: The Reference Object associated with the Object State Action Definition
+        type: string
+        required: false
+      referenceObjectId:
+        description: The Reference Object ID associated with the Object State Action Definition
+        type: string
+        required: false
+  ContractDocumentVersionRepresentation:
+    description: ContractDocumentVersion record
+    type: object
+    properties:
+      contractDocumentVersionId:
+        description: The record Id of ContractDocumentVersion
+        type: string
+      contractId:
+        description: The record Id of parent Contract
+        type: string
+      createdByFullName:
+        description: The status of ContractDocumentVersion
+        type: string
+        required: false
+      createdDate:
+        description: The createdDate of ContractDocumentVersion
+        type: string
+      creationProcessType:
+        description: The creationProcessType of ContractDocumentVersion
+        type: string
+        required: false
+      documentTemplateId:
+        description: The templateId used for ContractDocumentVersion
+        type: string
+        required: false
+      isDocumentVersionLocked:
+        description: The isDocumentVersionLocked flag of ContractDocumentVersion
+        type: boolean
+      lastModifiedDate:
+        description: The lastModifiedDate of ContractDocumentVersion
+        type: string
+      lockType:
+        description: The lockType of ContractDocumentVersion
+        type: string
+        required: false
+      lockedByUserName:
+        description: The lockedByUserName of ContractDocumentVersion
+        type: string
+        required: false
+      name:
+        description: The versionName of ContractDocumentVersion
+        type: string
+      status:
+        description: The status of ContractDocumentVersion
+        type: string
+      versionNumber:
+        description: The versionNumber of ContractDocumentVersion
+        type: string
+  ContractDocumentVersionsListRepresentation:
+    description: ContractDocumentVersions record list
+    type: object
+    properties:
+      contractId:
+        description: Contract ID for which list of contractDocumentVersions fetched
+        type: string
+      data:
+        description: List of ContractDocumentVersions details associated to the Contract
+        type: array
+        required: false
+        items:
+          type: ContractDocumentVersionRepresentation
+  ContractInputRepresentation:
+    description: An Input Representation for create and update Contract Api.
+    type: object
+    properties:
+      isAutoDocgenRequired:
+        description: 'Is Auto Document Generation Required. '
+        type: boolean
+      sourceObjectId:
+        description: Source Record Id.
+        type: string
+      templateName:
+        description: Document Template Name for Document Generation.
+        type: string
+  ContractOutputResponseRepresentation:
+    description: Contract List
+    type: object
+    properties:
+      data:
+        description: 'The record Ids of the Contacts '
+        type: array
+        items:
+          type: string
+  DocumentGenerateRepresentation:
+    description: DocumentGenerateRepresentation record
+    type: object
+    properties:
+      contentDocuments:
+        description: List of Generated Content Document details associated to the
+          ContractDocumentVersion
+        type: array
+        required: false
+        items:
+          type: ContentDocumentRepresentation
+      contractDocumentVersionId:
+        description: The record Id of ContractDocumentVersion
+        type: string
+      contractId:
+        description: The record Id of Contract
+        type: string
+      jobId:
+        description: The Job ID of generate document process enqueued after contractDocumentVersion
+          creation
+        type: string
+        required: false
+  DocumentGenerationProcessStatusRepresentation:
+    description: Output representation of Document Generation Process
+    type: object
+    properties:
+      contentDocuments:
+        description: List of Generated Content Document details associated to the
+          ContractDocumentVersion
+        type: array
+        required: false
+        items:
+          type: ContentDocumentRepresentation
+      contractDocumentVersionId:
+        description: contractDocumentVersionId
+        type: string
+      documentGenerationProcessId:
+        description: DocumentGenerationProcessId
+        type: string
+        required: false
+      name:
+        description: Name
+        type: string
+        required: false
+      responseText:
+        description: responseText
+        type: string
+        required: false
+      status:
+        description: Status
+        type: string
+        required: false
+      documentUrl:
+        description: Document Url for the external Document
+        type: string
+        required: false
+  GenericOutputRepresentation:
+    description: Generic Output Representation
+    type: object
+    properties:
+      id:
+        description: id
+        type: string
+      isSuccess:
+        description: API success status
+        type: boolean
+        required: false
+  TemplateInputRepresentation:
+    description: Input representation to get TemplateId
+    type: object
+    properties:
+      templateId:
+        description: Template Id with Key Prefix 2dt
+        type: string
+      pdfDocumentId:
+        description: contract pdf document id
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      wordDocumentId:
+        description: contract word document id
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  TemplateListRepresentation:
+    description: Output representation of Templates
+    type: object
+    properties:
+      code:
+        description: API code
+        type: string
+        required: false
+      data:
+        description: The list of templates
+        type: array
+        items:
+          type: TemplateRepresentation
+      message:
+        description: API message
+        type: string
+        required: false
+  TemplateRepresentation:
+    description: Template Record
+    type: object
+    properties:
+      id:
+        description: The record Id of the Template
+        type: string
+      isActive:
+        description: The status of the Template
+        type: boolean
+      name:
+        description: The name of the Template
+        type: string
+      type:
+        description: The type of the Template
+        type: string
+      version:
+        description: The version of the Template
+        type: integer
+  SaveExternalDocumentInputRepresentation:
+    description: Input representation to save external document to salesforce
+    type: object
+    properties:
+      extDocumentId:
+        description: External Document ID
+        type: string
+  SaveExternalDocumentRepresentation:
+    description: Output representation for Save External Document
+    type: object
+    properties:
+      id:
+        description: Id of the document
+        type: string
+      isSuccess:
+        description: The isSuccess flag for SaveExternalDocument
+        type: boolean
+      message:
+        description: The response message for SaveExternalDocument
+        type: string
+        required: false
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  TemplateInputRepresentationWrapper:
+    description: Wrapper for TemplateInputRepresentation
+    type: object
+    properties:
+      templateInput:
+        type: TemplateInputRepresentation
+        description: Input representation to get TemplateId
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  ContractActionInputRepresentationWrapper:
+    description: Wrapper for ContractActionInputRepresentation
+    type: object
+    properties:
+      actionInput:
+        type: ContractActionInputRepresentation
+        description: Input representation to get apiName for Contract action
+  # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  ContractInputRepresentationWrapper:
+    description: Wrapper for ContractInputRepresentation
+    type: object
+    properties:
+      contractInputPayload:
+        type: ContractInputRepresentation
+        description: An Input Representation for create and update Contract Api.
+  SaveExternalDocumentInputRepresentationWrapper:
+    description: Wrapper for SaveExternalDocumentInputRepresentation
+    type: object
+    properties:
+      externalDocumentInput:
+        type: SaveExternalDocumentInputRepresentation
+        description: Input representation to save external document to salesforce
+
+/connect:
+  /clm:
+    /contract:
+      patch:
+        description: Update contract details based on object Id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContractOutputResponseRepresentation
+        body:
+          application/json:
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            type: ContractInputRepresentationWrapper
+            # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): contractInputPayload
+      post:
+        description: Create contract based on the object id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContractOutputResponseRepresentation
+        body:
+          application/json:
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            type: ContractInputRepresentationWrapper
+            # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): contractInputPayload
+    /contract/{contractId}/contract-document-version:
+      get:
+        description: Get contract document version details based on id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ContractDocumentVersionsListRepresentation
+        queryParameters:
+          contractDocumentVersionId:
+            type: string
+            required: false
+      post:
+        description: Create contract document version for input contractId and generateDocument
+          w.r.t. templateId passed
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentGenerateRepresentation
+        body:
+          application/json:
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            type: TemplateInputRepresentationWrapper
+            # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): templateInput
+      uriParameters:
+        contractId:
+          type: string
+          required: true
+    /contract/{contractId}:
+      patch:
+        description: Executes given action on the provided contract
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericOutputRepresentation
+        body:
+          application/json:
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            type: ContractActionInputRepresentationWrapper
+            # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): actionInput
+      uriParameters:
+        contractId:
+          type: string
+          required: true
+      /contract-actions:
+        get:
+          description: Get list of actions possible for the particular contract
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContractActionListRepresentation
+        uriParameters:
+          contractId:
+            type: string
+            required: true
+    /contract-document-version/{contractDocumentVersionId}:
+      patch:
+        description: Update the Contract Document Version when template is changed
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentGenerateRepresentation
+        body:
+          application/json:
+            # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+            type: TemplateInputRepresentationWrapper
+            # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+            # required: false
+            (oas-body-name): templateInput
+      uriParameters:
+        contractDocumentVersionId:
+          type: string
+          required: true
+      /checkIn:
+        patch:
+          description: CheckIn a Contract Document Version using Contract Document Version
+            ID
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GenericOutputRepresentation
+        uriParameters:
+          contractDocumentVersionId:
+            type: string
+            required: true
+      /checkout:
+        post:
+          description: Checkout contract document version
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DocumentGenerateRepresentation
+          body:
+            application/json:
+              # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+              type: TemplateInputRepresentationWrapper
+              # TODO: Hand-rolled due to issue #22 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+              # required: false
+              (oas-body-name): templateInput
+        uriParameters:
+          contractDocumentVersionId:
+            type: string
+            required: true
+      /content-documents:
+        delete:
+          description: Delete attachments based on contentDocumentId & contractDocumentVersionId
+          responses:
+            '200':
+              description: Success
+          queryParameters:
+            contentDocumentId:
+              type: string
+              required: false
+        get:
+          description: Get content documents for given contractDocumentVersionId
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: ContentDocumentListRepresentation
+        uriParameters:
+          contractDocumentVersionId:
+            type: string
+            required: true
+      /lock:
+        patch:
+          description: Lock contract document version
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GenericOutputRepresentation
+        uriParameters:
+          contractDocumentVersionId:
+            type: string
+            required: true
+      /unlock:
+        patch:
+          description: Unlock a Contract Document Version using Contract Document Version
+            ID
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GenericOutputRepresentation
+        uriParameters:
+          contractDocumentVersionId:
+            type: string
+            required: true
+    /document-generation-process/status:
+      get:
+        description: Get Template details based on version id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DocumentGenerationProcessStatusRepresentation
+        queryParameters:
+          contractDocumentVersionId:
+            type: string
+            required: false
+    /document-template:
+      get:
+        description: Get Template details based on version id
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: TemplateListRepresentation
+        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
+    /external-document-resource:
+      patch:
+        description: Saves the external document to salesforce
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: SaveExternalDocumentRepresentation
+        body:
+          application/json:
+            type: SaveExternalDocumentInputRepresentationWrapper
+            (oas-body-name): externalDocumentInput