@salesforce/lds-adapters-industries-filebased-dataimport 1.247.0

package/src/raml/api.raml

@@ -0,0 +1,252 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v60.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:
+  FieldConfigurationInputRepresentation:
+    description: Input representation of the field configurations from CSV columns
+      to Salesforce Object Columns for the Data Import Job
+    type: object
+    properties:
+      isLookupRelationship:
+        description: To identify wether it is a lookup relationship
+        type: boolean
+        required: false
+      relatedFieldName:
+        description: The name of the field of the object of the lookup relationship.
+        type: string
+        required: false
+      relatedObjectName:
+        description: The name of the object where the lookup needs to be performed
+          for this entity field
+        type: string
+        required: false
+      sourceColumnName:
+        description: The name of the column of the source content for this mapping
+          definition
+        type: string
+        required: false
+      targetFieldName:
+        description: The field name of the targeted import object for this mapping
+          definition
+        type: string
+        required: false
+  FileImportInputRepresentation:
+    description: Input representation of payload for File Based Data Import Use Case
+    type: object
+    properties:
+      importReferenceId:
+        description: The id of the file based data import functionality entity
+        type: string
+      options:
+        description: The Options and configurations of the import job
+        type: ImportOptionsInputRepresentation
+        required: false
+      targetContext:
+        description: The target context of import be it a object or a import template
+        type: string
+  FileImportOutputRepresentation:
+    description: Output representation of a File Based Import Job
+    type: object
+    properties:
+      statusCode:
+        description: The status code of the Start Import Job API
+        type: string
+      statusMessage:
+        description: The status message of the Start Import Job API
+        type: string
+  ImportOperationInputRepresentation:
+    description: Input representation of operations for File Based Import Case
+    type: object
+    properties:
+      operationType:
+        description: The operation type of the import job
+        type: string
+        required: false
+      uniqueFields:
+        description: The unique fields of the object on which Update or upsert kind
+          of operations are to be performed
+        type: array
+        required: false
+        items:
+          type: string
+  ImportOptionsInputRepresentation:
+    description: Input representation of Options for File Based Import
+    type: object
+    properties:
+      delimiter:
+        description: The delimiter of the source content document
+        type: string
+        required: false
+      eol:
+        description: The End of Line character for the file used for import
+        type: string
+        required: false
+      fieldConfigurations:
+        description: The list of field configurations
+        type: array
+        required: false
+        items:
+          type: FieldConfigurationInputRepresentation
+      operation:
+        description: The operation type of the import job
+        type: ImportOperationInputRepresentation
+        required: false
+  FileBasedDataImportByUserResultRepresentation:
+    description: Output representation file based data imports as per user context
+    type: object
+    properties:
+      isAdminUser:
+        description: True if user has admin role
+        type: boolean
+      fileBasedDataImportRepresentations:
+        description: The file based data import response
+        type: array
+        items:
+          type: FileBasedDataImportRepresentation
+  FileBasedDataImportRepresentation:
+    description: File based Data import Entity output representation
+    type: object
+    properties:
+      jobIdentifier?:
+        description: jobIdentifier
+        type: string
+      targetContext?:
+        description: targetContext
+        type: string
+      failedRecordsCount?:
+        description: FailedRecordsCount
+        type: integer
+      fileBasedImportType?:
+        description: FileBasedImportType
+        type: string
+        enum:
+          - ADVANCED
+          - SIMPLE
+      importOperationType?:
+        description: ImportOperationType
+        type: string
+        enum:
+          - INSERT
+          - UPDATE
+          - UPSERT
+      sourceContentDocument:
+        description: SourceContentDocument
+        type: string
+      status:
+        description: Status
+        type: string
+        enum:
+          - ABORTED
+          - COMPLETED
+          - FAILED
+          - INPROGRESS
+      statusReason?:
+        description: StatusReason
+        type: string
+      successRecordsCount?:
+        description: SuccessRecordsCount
+        type: integer
+      unprocessedRecordsCount?:
+        description: UnprocessedRecordsCount
+        type: integer
+  CsvPreviewOutputRepresentation:
+    description: Output representation of CSV Data Preview
+    type: object
+    properties:
+      headers:
+        description: List of header
+        type: array
+        items:
+          type: string
+      rows:
+        description: List of rows data fetched
+        type: array
+        items:
+          type: array
+          items:
+            type: string
+/connect/industries/fileBasedDataImports:
+  get:
+    displayName: GetFileBasedDataImportByUser
+    description: Api to fetch details related to mulesoft asset from metadata
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FileBasedDataImportByUserResultRepresentation
+
+  /advanceImport:
+    post:
+      displayName: postAdvanceImport
+      description: API resource to start Advance data import
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileImportOutputRepresentation
+      body:
+        application/json:
+          type: FileImportInputRepresentation
+  /simpleImport:
+    post:
+      displayName: postSimpleImport
+      description: API resource to start Simple data import
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileImportOutputRepresentation
+      body:
+        application/json:
+          type: FileImportInputRepresentation
+  /{fileBasedImportId}:
+    /preview:
+      get:
+        displayName: GetCsvPreview
+        description: Api to fetch preview of the csv file upto max 10 rows
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CsvPreviewOutputRepresentation
+        queryParameters:
+          delimiter:
+            type: string
+            required: false
+          endOfLine:
+            type: string
+            required: false
+          numberOfRows:
+            type: integer
+            required: false
+      uriParameters:
+        fileBasedImportId:
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,50 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'fileBased-dataimport'
+
+types:
+  FileImportOutputRepresentation:
+    (luvio.ttl): 0
+    (luvio.key):
+      statusCode: statusCode
+  FileBasedDataImportByUserResultRepresentation:
+    (luvio.ttl): 0
+  CsvPreviewOutputRepresentation:
+    (luvio.ttl): 0
+
+/connect/industries/fileBasedDataImports:
+  get:
+    (luvio.adapter):
+      name: getFileBasedDataImports
+
+  /advanceImport:
+    post:
+      (luvio.adapter):
+        name: startAdvanceImport
+
+  /simpleImport:
+    post:
+      (luvio.adapter):
+        name: startSimpleImport
+
+  /{fileBasedImportId}:
+    /preview:
+      get:
+        (luvio.adapter):
+          name: getGetCsvPreview
+        queryParameters:
+          delimiter:
+            type: string
+            required: false
+          endOfLine:
+            type: string
+            required: false
+          numberOfRows:
+            type: integer
+            required: false
+      uriParameters:
+        fileBasedImportId: