@salesforce/lds-adapters-cdp-document-processing 1.354.0-dev10

package/src/raml/api.raml

@@ -0,0 +1,484 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '64.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v64.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:
+  CdpUserRepresentation:
+    description: Represents a user
+    type: object
+    properties:
+      id:
+        description: The 18 character user ID
+        type: string
+      name:
+        description: The name of the user
+        type: string
+      profilePhotoUrl:
+        description: The Chatter profile photo of the user
+        type: string
+  CdpAssetBaseRepresentation:
+    description: Represents a base Asset
+    type: object
+    discriminator: id
+    properties:
+      createdBy:
+        description: Created by
+        type: any
+      createdDate:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by
+        type: any
+      lastModifiedDate:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      url:
+        description: Url
+        type: any
+  CdpPaginatedResponseBaseRepresentation:
+    description: Base paginated response representation
+    type: object
+    discriminator: totalSize
+    properties:
+      currentPageUrl:
+        description: Current page url
+        type: string | nil
+      nextPageUrl:
+        description: Next page url if it exists
+        type: string | nil
+      totalSize:
+        description: Total size of collection
+        type: integer
+  IdpConfigurationBaseRepresentation:
+    description: Idp Configuration Base Representation
+    type: CdpAssetBaseRepresentation
+    discriminator: version
+    properties:
+      activationStatus:
+        description: IDP Configuration Activation Status (Activated - Deactivated)
+        type: string
+        enum:
+          - Activated
+          - Deactivated
+      dataspace:
+        description: IDP Configuration Data Space
+        type: any
+      description:
+        description: IDP Configuration Description
+        type: string | nil
+      mlModel:
+        description: The ML model used to extract the unstructured data
+        type: string
+      runtimeStatus:
+        description: 'What is the status of the last off-core unstructured data-extraction
+          job run. Possible values: Success - Failed - InProgress - Aborted - NotStarted
+          - Pending - Submitted - Ready'
+        type: string
+        enum:
+          - Aborted
+          - Failed
+          - InProgress
+          - NotStarted
+          - Pending
+          - Ready
+          - Submitted
+          - Success
+      status:
+        description: 'Whether the latest version of this IDP configuration has been
+          synced to off-core. Possible values: Syncing - Synced - NotSynced - Error'
+        type: string
+        enum:
+          - Error
+          - NotSynced
+          - Synced
+          - Syncing
+      version:
+        description: The current version of the IDP configuration, this is incremented
+          automatically with every edit
+        type: string
+  IdpConfigurationDetailsRepresentation:
+    description: Idp Configuration Details Representation
+    type: object
+    properties:
+      schemaConfig:
+        description: The schema of the data to be extracted
+        type: string
+      createdBy:
+        description: Created by
+        type: any
+      createdDate:
+        description: Created date
+        type: string
+      id:
+        description: The 18 character ID of the asset
+        type: string
+      label:
+        description: Label of the asset
+        type: string
+      lastModifiedBy:
+        description: Last modified by
+        type: any
+      lastModifiedDate:
+        description: Last modified date
+        type: string
+      name:
+        description: Name of the asset
+        type: string
+      description:
+        description: description of config
+        type: any
+      mlModel:
+        description: fileConfig
+        type: string | nil
+      runtimeStatus:
+        description: fileConfig
+        type: string | nil
+  IdpConfigurationInputRepresentation:
+    description: The input representation for Idp Configuration
+    type: object
+    properties:
+      activationStatus:
+        description: Activated/Deactivated
+        type: string
+        enum:
+          - Activated
+          - Deactivated
+      description:
+        description: The description of the IDP configuration to be created
+        type: string
+      fileConfig:
+        description: The specs for the file types supported by the IDP process to
+          be created
+        type: object
+        properties:
+          fileTypes:
+            description: List of file formats that are supported by the IDP process to be created
+            type: array
+            items:
+              type: string
+      label:
+        description: The label of the IDP configuration to be created
+        type: string
+      mlModel:
+        description: The ML model used to extract the unstructured data
+        type: string
+      name:
+        description: The API name of the IDP configuration to be created
+        type: string
+      configMetadata:
+        description: A map of custom key-value pairs serialized as JSON
+        type: object
+        properties:
+          builderType:
+            description: Source of idp config creation
+            type: string
+      schemaConfig:
+        description: The schema of the data to be extracted
+        type: string
+  IdpConfigurationPatchInputRepresentation:
+    description: The update input representation for Idp Configuration
+    type: object
+    properties:
+      activationStatus:
+        description: The updated activation status - Activated/Deactivated
+        type: string
+        enum:
+          - Activated
+          - Deactivated
+      description:
+        description: The updated description of the IDP configuration to be created
+        type: string
+      label:
+        description: The updated label of the IDP configuration to be created
+        type: string
+  IdpConfigurationRepresentation:
+    description: Idp Configuration Representation
+    type: IdpConfigurationBaseRepresentation
+    properties: {}
+  IdpConfigurationsCollectionRepresentation:
+    description: Idp Configuration Collection Representation
+    type: CdpPaginatedResponseBaseRepresentation
+    properties:
+      configurations:
+        description: The IDP configuration records in the current page
+        type: array
+        items:
+          type: IdpConfigurationRepresentation
+  IdpContentTypeRepresentation:
+    description: Idp Content Type Representation
+    type: object
+    properties:
+      isDefault:
+        description: If this value by default
+        type: boolean
+      label:
+        description: The display name of the file type
+        type: string
+      maxFileSizeInMB:
+        description: Max size of the file in mega bytes
+        type: integer
+      type:
+        description: The file type
+        type: string
+  IdpFileConfigRepresentation:
+    description: The representation of the specs for the file types supported by the
+      IDP process
+    type: object
+    properties:
+      fileTypes:
+        description: List of file formats that are supported by the IDP process to
+          be created
+        type: array
+        items:
+          type: string
+  IdpGlobalConfigRepresentation:
+    description: Idp Global Config Representation
+    type: object
+    properties:
+      supportedContentTypes:
+        description: All content types currently supported for unstructured data extraction
+        type: array
+        items:
+          type: IdpContentTypeRepresentation
+      supportedModels:
+        description: Models currently supported for unstructured data extraction
+        type: array
+        items:
+          type: IdpSupportedModelRepresentation
+      version:
+        description: The version of the config schema
+        type: string
+  IdpSupportedModelRepresentation:
+    description: Idp Supported Model Representation
+    type: object
+    properties:
+      id:
+        description: The ID of the model
+        type: string
+      isDefault:
+        description: If it is default
+        type: boolean
+      label:
+        description: The display name of the model
+        type: string
+      provider:
+        description: E.g. Open AI
+        type: string
+      status:
+        description: E.g. ENABLED, DISABLED
+        type: string
+  IdpGenerateSchemaFileInputRepresentation:
+    description: The generate schema file input representation for Idp Configuration
+    type: object
+    properties:
+      fileId:
+        description: Either a Salesforce file Id or a URI to SF Drive
+        type: string
+  IdpGenerateSchemaInputRepresentation:
+    description: The generate schema input representation for Idp Configuration
+    type: object
+    properties:
+      files:
+        description: The list of unstructured source files to extract the schema from
+        type: array
+        items:
+          type: IdpGenerateSchemaFileInputRepresentation
+      mlModel:
+        description: The ID of the ML model to use for schema extraction
+        type: string
+  IdpGeneratedSchemaRepresentation:
+    description: Idp Generated Schema Representation
+    type: object
+    properties:
+      error:
+        description: Error message if schema generation fails
+        type: string | nil
+      schema:
+        description: The generated schema in JSON format
+        type: string
+  IdpExtractDataInputRepresentation:
+    description: The extract data input representation for Idp Configuration
+    type: object
+    properties:
+      files:
+        description: The list of unstructured source files to extract the schema from
+        type: array
+        items:
+          type: object
+          properties:
+            fileId:
+              description: documentVersionId of the selected file
+              type: string
+      mlModel:
+        description: The ID of the ML model to use for schema extraction
+        type: string
+      schemaConfig:
+        description: The schema of the data to be extracted
+        type: string
+  IdpExtractedDataRepresentation:
+    description: Idp Extracted Data Representation
+    type: object
+    properties:
+      data:
+        description: 'List of extraction result for every file '
+        type: array
+        items:
+          type: IdpExtractedFileDataRepresenation
+  IdpExtractedFileDataRepresenation:
+    description: Idp Extracted Data Representation for a specific file
+    type: object
+    properties:
+      data:
+        description: Extracted JSON data
+        type: string
+      error:
+        description: Error message if data extraction fails
+        type: string | nil
+/ssot/document-processing:
+  /configurations:
+    get:
+      displayName: getIdpConfigurations
+      description: Get all intelligent document processing configurations
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpConfigurationsCollectionRepresentation
+      queryParameters:
+        activationStatus:
+          type: string
+          required: false
+          enum:
+            - Activated
+            - Deactivated
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+        orderBy:
+          description: eg. Label DESC
+          type: string
+          required: false
+        search:
+          type: string
+          required: false
+    post:
+      displayName: createIdpConfiguration
+      description: Create idp configuration
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpConfigurationDetailsRepresentation
+      body:
+        application/json:
+          type: IdpConfigurationInputRepresentation
+          (oas-body-name): createIdpConfigurationRecord
+  /configurations/{idOrApiName}:
+    delete:
+      displayName: deleteIdpConfiguration
+      description: delete an idp configuration record
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getIdpConfiguration
+      description: get the details of a specific idp configuration record
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpConfigurationDetailsRepresentation
+    patch:
+      displayName: updateIdpConfiguration
+      description: updates the details of a specific idp configuration record
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpConfigurationDetailsRepresentation
+      body:
+        application/json:
+          type: IdpConfigurationPatchInputRepresentation
+          (oas-body-name): patchIdpConfigurationRecord
+    uriParameters:
+      idOrApiName:
+        description: Document processing Config ID
+        type: string
+        required: true
+  /global-config:
+    get:
+      displayName: getIdpGlobalConfig
+      description: get the details of idp global config
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpGlobalConfigRepresentation
+  /actions/generate-schema:
+    post:
+      displayName: generateIdpConfigurationSchema
+      description: generate schema for idp configuration
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpGeneratedSchemaRepresentation
+      body:
+        application/json:
+          type: IdpGenerateSchemaInputRepresentation
+          (oas-body-name): generateIdpConfigurationSchema
+  /actions/extract-data:
+    post:
+      displayName: extractDataUsingIdpConfiguration
+      description: extract data from idp configuration
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: IdpExtractedDataRepresentation
+      body:
+        application/json:
+          type: IdpExtractDataInputRepresentation
+          (oas-body-name): extractDataUsingIdpConfiguration

package/src/raml/luvio.raml

@@ -0,0 +1,116 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'document-processing'
+
+types:
+  IdpSupportedModelRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpConfigurationRepresentation:
+    (luvio.opaque): true
+
+  IdpConfigurationBaseRepresentation:
+    (luvio.opaque): true
+
+  IdpFileConfigRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpContentTypeRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpGlobalConfigRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  CdpPaginatedResponseBaseRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpConfigurationsCollectionRepresentation:
+    (luvio.opaque): true
+
+  IdpConfigurationInputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpConfigurationDetailsRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+
+  IdpConfigurationPatchInputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpGenerateSchemaFileInputRepresentation:
+    (luvio.opaque): true
+
+  IdpGenerateSchemaInputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpGeneratedSchemaRepresentation:
+    (luvio.ttl): 1200000
+    (luvio.key):
+      schema: schema
+
+  IdpExtractDataInputRepresentation:
+    (luvio.ttl): 500
+    (luvio.opaque): true
+
+  IdpExtractedDataRepresentation:
+    (luvio.ttl): 1200000
+
+  IdpExtractedFileDataRepresenation:
+    (luvio.opaque): true
+
+/ssot/document-processing:
+  /configurations:
+    get:
+      (luvio.adapter):
+        name: getIdpConfigurations
+
+    post:
+      (luvio.adapter):
+        name: createIdpConfiguration
+
+  /configurations/{idOrApiName}:
+    delete:
+      (luvio.adapter):
+        name: deleteIdpConfiguration
+      (luvio.key):
+        id: urlParams.idOrApiName
+
+    get:
+      (luvio.adapter):
+        name: getIdpConfiguration
+      (luvio.key):
+        id: urlParams.idOrApiName
+
+    patch:
+      (luvio.adapter):
+        name: updateIdpConfiguration
+
+  /global-config:
+    get:
+      (luvio.adapter):
+        name: getIdpGlobalConfig
+
+  /actions/generate-schema:
+    post:
+      (luvio.adapter):
+        name: generateIdpConfigurationSchema
+
+  /actions/extract-data:
+    post:
+      (luvio.adapter):
+        name: extractDataUsingIdpConfiguration
+      (luvio.method): get