@salesforce/lds-adapters-industries-sustainability-reference-data-v3 1.249.0

package/src/raml/api.raml

@@ -0,0 +1,191 @@
+#%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:
+  EntityDatasetVersionDetailRepresentation:
+    description: Input representation for the upload datasets
+    type: object
+    properties:
+      dataIdentifier:
+        description: Data Identifier of the dataset that needs to be updated
+        type: string
+      recordTypeId:
+        description: Record type of the entity
+        type: string
+      versionNumber:
+        description: Version number of the entity
+        type: string
+  GetDataSetMetaOutputRepresentation:
+    description: Get dataset metadata output representation
+    type: object
+    properties:
+      referenceDataRepresentation:
+        description: Get dataset metadata output representation
+        type: array
+        items:
+          type: ReferenceDataRepresentation
+  ReferenceDataRepresentation:
+    description: Reference Data Information
+    type: object
+    properties:
+      entityObject:
+        description: Entity Name of the Object
+        type: string
+      referenceDatasetsRepresentation:
+        description: List of datasets for the entity object
+        type: array
+        items:
+          type: ReferenceDatasetsRepresentation
+  ReferenceDataVersionsRepresentation:
+    description: Reference Dataset Versions
+    type: object
+    properties:
+      loadBy:
+        description: Name of user that loaded the dataset
+        type: string
+      loadDate:
+        description: Date when the dataset was loaded
+        type: string
+      loadStatus:
+        description: get the load status of the dataset
+        type: string
+      publishDate:
+        description: get the publish date of the dataset
+        type: string
+      salesforceRelease:
+        description: get a list of salesforce release of the dataset
+        type: array
+        items:
+          type: string
+      versionNotes:
+        description: get the version notes of the dataset
+        type: string
+      versionNumber:
+        description: get the version number of the dataset
+        type: string
+      versionTag:
+        description: get the version tag of the dataset
+        type: string
+  ReferenceDatasetsRepresentation:
+    description: Reference Datasets Information
+    type: object
+    properties:
+      categoryName:
+        description: Category name of the dataset
+        type: string
+      dataIdentifier:
+        description: Get the data identifier of the dataset
+        type: string
+      description:
+        description: Get the description of the dataset
+        type: string
+      locationRegion:
+        description: Get the location region of the dataset
+        type: string
+      locationSubregion:
+        description: Get the location sub region of the dataset
+        type: string
+      locationSubsubregion:
+        description: Get the location sub sub region of the dataset
+        type: string
+      name:
+        description: Get the name of the dataset
+        type: string
+      productDetailUrl:
+        description: Get the product detail url of the dataset
+        type: string
+      providerName:
+        description: Get the provider name of the dataset
+        type: string
+      referenceDataVersionsRepresentations:
+        description: List of Reference data source versions
+        type: array
+        items:
+          type: ReferenceDataVersionsRepresentation
+      source:
+        description: get a list of sources of the dataset
+        type: array
+        items:
+          type: string
+      timeframeEndDate:
+        description: Get the time frame end date of the dataset
+        type: string
+      timeframeStartDate:
+        description: Get the time frame start date of the dataset
+        type: string
+      updateFrequency:
+        description: Get the update frequency of the dataset
+        type: string
+  UploadDatasetOutputRepresentation:
+    description: Response for the Upload Emissions Factor from NZM to NZC
+    type: object
+    properties:
+      code:
+        description: Response code
+        type: integer
+      message:
+        description: Response message
+        type: string
+  UploadDatasetInputRepresentation:
+    description: Upload Dataset input representation
+    type: object
+    properties:
+      entityDatasetVersionDetailRepresentations:
+        description: Entity Dataset Version Representation
+        type: array
+        items:
+          type: EntityDatasetVersionDetailRepresentation
+/connect/sustainability:
+  /reference-data:
+    /v3:
+      /entitySection/{entitySection}:
+        get:
+          displayName: getSCGetDatasetMetaResource
+          description: Get dataset metadata from NZM
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GetDataSetMetaOutputRepresentation
+        uriParameters:
+          entitySection:
+            type: string
+            required: true
+      /entityVersion/upload:
+        post:
+          displayName: postUploadDataset
+          description: Upload Emissions Factor data from NZM to NZC
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: UploadDatasetOutputRepresentation
+          body:
+            application/json:
+              type: UploadDatasetInputRepresentation
+              (oas-body-name): uploadDatasetEntityInput

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-v3'
+types:
+  GetDataSetMetaOutputRepresentation:
+    (luvio.ttl): 10000
+    (luvio.opaque): true
+
+  UploadDatasetOutputRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+    (luvio.key):
+      message: message
+
+/connect/sustainability:
+  /reference-data:
+    /v3:
+      /entitySection/{entitySection}:
+        get:
+          (luvio.adapter):
+            name: getSCGetDatasetMetaResource
+      /entityVersion/upload:
+        post:
+          (luvio.adapter):
+            name: postUploadDataset