@salesforce/lds-adapters-industries-sustainability-reference-data-v2 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,187 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  ReferenceDataVersionRepresentation:
+    description: Reference Data Version Information
+    type: object
+    properties:
+      isDataSourceLoaded:
+        description: Is the data source loaded successfully
+        type: boolean
+      isUnlocked:
+        description: Is the version locked from usage
+        type: boolean
+      lastLoadDate:
+        description: Reference data last loaded date
+        type: string
+        required: false
+      lastLoadStatus:
+        description: Reference data last loaded status
+        type: string
+      lastLoadedBy:
+        description: Last loaded by user information
+        type: string
+        required: false
+      releaseDate:
+        description: Reference data source release date
+        type: string
+      salesforceRelease:
+        description: Reference data source version released in salesforce release
+        type: string
+      updateNotes:
+        description: Reference data source release notes
+        type: string
+      updateYear:
+        description: Reference data source version release year
+        type: string
+      version:
+        description: Reference data source version
+        type: string
+  ReferenceDataSourceRepresentation:
+    description: Reference Data Source Information
+    type: object
+    properties:
+      dataSourceName:
+        description: Data source name
+        type: string
+      isUpdateAvailable:
+        description: Is update available for the data source
+        type: boolean
+      latestVersion:
+        description: Latest data sorce version
+        type: string
+      versions:
+        description: List of Reference data source versions
+        type: array
+        items:
+          type: ReferenceDataVersionRepresentation
+  ReferenceDataEntityRepresentation:
+    description: Reference Data Entity Section Information
+    type: object
+    properties:
+      entityName:
+        description: Entity section name
+        type: string
+      referenceDataSourceRepresentation:
+        description: List of Reference data sources for the entity section
+        type: array
+        items:
+          type: ReferenceDataSourceRepresentation
+  FetchEntityVersionOutputRepresentation:
+    description: Entity Version Output Representation
+    type: object
+    properties:
+      referenceDataEntityRepresentation:
+        description: List of Reference data entity sections
+        type: array
+        items:
+          type: ReferenceDataEntityRepresentation
+  UploadEntityVersionOutputRepresentation:
+    description: Response containing Status code and User Friendly Message
+    type: object
+    properties:
+      code:
+        description: Code for the response status
+        type: integer
+      message:
+        description: Message returned for the Client
+        type: string
+  EntityDataSourceVersionDetailRepresentation:
+    description: Upload Entity Version Input
+    type: object
+    properties:
+      dataSource:
+        description: Data Source Name
+        type: string
+      entitySection:
+        description: Entity Section Name
+        type: string
+      recordTypeId:
+        description: RecordTypeId
+        type: string
+      version:
+        description: Version
+        type: string
+  UploadEntityVersionInputWrapperRepresentation:
+    description: A Wrapper around the UploadEntityVersionInputRepresentation
+    type: object
+    properties:
+      uploadEntityInput:
+        description: The Oas Body Name for uploadEntityInput.
+        type: UploadEntityVersionInputRepresentation
+  UploadEntityVersionInputRepresentation:
+    description: Upload Entity Version Input
+    type: object
+    properties:
+      entityDataSourceVersionDetails:
+        description: Entity DataSource Version Representation
+        type: array
+        items:
+          type: EntityDataSourceVersionDetailRepresentation
+/connect/sustainability:
+  /reference-data:
+    /v2:
+      /entitySection/{entitySection}/dataSource/{referenceDataSource}/version:
+        get:
+          description: Fetch Entity Versions based on LoadType
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: FetchEntityVersionOutputRepresentation
+          queryParameters:
+            loadType:
+              type: string
+              required: false
+            order:
+              type: string
+              required: false
+            size:
+              type: integer
+              required: false
+        uriParameters:
+          entitySection:
+            type: string
+            required: true
+          referenceDataSource:
+            type: string
+            required: true
+      /entityVersion/upload:
+        put:
+          description: Upload  CSV data for the Entity Version
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: UploadEntityVersionOutputRepresentation
+          body:
+            application/json:
+              type: UploadEntityVersionInputWrapperRepresentation
+              #required: false
+              (oas-body-name): uploadEntityInput

package/src/raml/luvio.raml

@@ -0,0 +1,29 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'sustainability-reference-data-v2'
+types:
+  FetchEntityVersionOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+
+  UploadEntityVersionOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+    (luvio.key):
+      message: message
+
+/connect/sustainability:
+  /reference-data:
+    /v2:
+      /entitySection/{entitySection}/dataSource/{referenceDataSource}/version:
+        get:
+          (luvio.adapter):
+            name: getEntityVersion
+      /entityVersion/upload:
+        put:
+          (luvio.adapter):
+            name: uploadEntityVersion