@salesforce/lds-adapters-industries-recordaggregation 1.283.0

package/src/raml/api.raml

@@ -0,0 +1,344 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '61.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v61.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:
+  RecordAggregationApplicableObjectOutputRepresentation:
+    description: Output representation for applicable object in record rollups.
+    type: object
+    properties:
+      apiName:
+        description: API name of the object.
+        type: string
+      label:
+        description: Label of the object.
+        type: string
+  RecordAggregationApplicableObjectsOutputRepresentation:
+    description: Output representation for applicable objects in record rollups.
+    type: object
+    properties:
+      message:
+        description: Message associated with the response status code.
+        type: string
+      objects:
+        description: List of objects that can be used in a rollup definition, including
+          the apiName and label attributes.
+        type: array
+        items:
+          type: RecordAggregationApplicableObjectOutputRepresentation
+      statusCode:
+        description: The HTTP Status Code for this response.
+        type: string
+  RecordAggregationAssociatedObjectInputRepresentation:
+    description: Input representation of associated object of a node in record aggregation
+      definition
+    type: object
+    properties:
+      apiName:
+        description: TODO
+        type: string
+  RecordAggregationCreationInputRepresentation:
+    description: Input representation of record aggregation definition creation api
+    type: object
+    properties:
+      aggregationObjects:
+        description: List of objects included in the record aggregation definition.
+          Each item in this collection represents object details, join field details,
+          and filter conditions.
+        type: array
+        items:
+          type: RecordAggregationNodeInputRepresentation
+      definitionDescription:
+        description: The description of the record aggregation definition.
+        type: string
+        required: false
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+  RecordAggregationCreationOutputRepresentation:
+    description: Represents the output for creating Record Aggregation Definition
+    type: object
+    properties:
+      message:
+        description: The message accompanying the HTTP response code.
+        type: string
+      recordAggregationDefinitionId:
+        description: Record aggregation definition ID.
+        type: string
+      statusCode:
+        description: HTTP response code.
+        type: string
+  RecordAggregationDefinitionInputRepresentation:
+    description: Input representation for Generate DPE Input Class
+    type: object
+    properties:
+      definitionId:
+        description: Record Aggregation Definition record id if nothing provided default
+          to ALL
+        type: string
+  RecordAggregationFilterInputRepresentation:
+    description: Input representation of filters of a node in record aggregation definition
+    type: object
+    properties:
+      filterConditions:
+        description: List of filter conditions containing details such as fields,
+          operators, and filtering values.
+        type: array
+        required: false
+        items:
+          type: RecordAggregationFilterRowInputRepresentation
+      filterCriteria:
+        description: A logical expression containing filter conditions, which is used
+          to filter records of the specified object.
+        type: string
+        required: false
+  RecordAggregationFilterRowInputRepresentation:
+    description: Input representation of filter row in filters of record aggregation
+      definition
+    type: object
+    properties:
+      fieldDeveloperName:
+        description: TODO
+        type: string
+      operator:
+        description: TODO
+        type: string
+      sequence:
+        description: TODO
+        type: integer
+      value:
+        description: TODO
+        type: string
+  RecordAggregationJoinInputRepresentation:
+    description: Input representation of join of a node in record aggregation definition
+    type: object
+    properties:
+      fieldDeveloperName:
+        description: The developer name of the field.
+        type: string
+  RecordAggregationNodeInputRepresentation:
+    description: Input representation of a node in record aggregation definition
+    type: object
+    properties:
+      filterDetails:
+        description: List of filter conditions and the filter criteria that are used
+          to filter records of the specified object.
+        type: RecordAggregationFilterInputRepresentation
+        required: false
+      nextObjectJoinDetails:
+        description: Name and API name of the join field in the current object that
+          is used to join with the next object.
+        type: RecordAggregationJoinInputRepresentation
+        required: false
+      objectDetails:
+        description: Name and API name of the object used in the record aggregation
+          definition.
+        type: RecordAggregationAssociatedObjectInputRepresentation
+      previousObjectJoinDetails:
+        description: Name and API name of the field in the current object that is
+          used to join with the preceding object.
+        type: RecordAggregationJoinInputRepresentation
+        required: false
+      sequence:
+        description: The position of the current object in the record aggregation
+          definition.
+        type: integer
+  RecordAggregationUpdationInputRepresentation:
+    description: Input representation of record aggregation definition updation api
+    type: object
+    properties:
+      aggregationObjects:
+        description: List of objects included in the record aggregation definition.
+          Each item in this collection represents object details, join field details,
+          and filters.
+        type: array
+        items:
+          type: RecordAggregationNodeInputRepresentation
+      definitionDescription:
+        description: The description of the record aggregation definition.
+        type: string
+        required: false
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+  RecordAggregationUpdationOutputRepresentation:
+    description: Represents the output for updating Record Aggregation Definition
+    type: object
+    properties:
+      message:
+        description: TODO
+        type: string
+      statusCode:
+        description: TODO
+        type: string
+  RecordRollupResultColumnOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      displayFormatType:
+        description: The data type of the field representing this column. This data
+          type corresponds to the type which the lightning data table understands.
+        type: string
+      displayFormatTypeAttributes:
+        description: A map of extra attributes related to the data type that can be
+          used in the lightning data table for additional formatting
+        type: object
+        properties:
+          //:
+            type: any
+      fieldApiName:
+        description: Api Name of the field representing the column.
+        type: string
+      fieldDataType:
+        description: The data type of the field representing this column.
+        type: string
+      fieldLabel:
+        description: Label of the field representing the column.
+        type: string
+      sequence:
+        description: The sequence in which the column should appear in the data table.
+        type: integer
+  RecordRollupResultInputRepresentation:
+    description: Input representation for fetching record aggregation result
+    type: object
+    properties:
+      isSortOrderAscending:
+        description: Indicates whether the sort order is set as ascending (true) or
+          not (false).The default value is set as descending when sortBy is not assigned
+          any value.
+        type: boolean
+        required: false
+      sortBy:
+        description: Criteria to sort the record rollup results. The default value
+          is CreatedDate.
+        type: string
+        required: false
+  RecordRollupResultOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      columns:
+        description: List of fields that are represented as columns of a table.
+        type: array
+        items:
+          type: RecordRollupResultColumnOutputRepresentation
+      definitionDisplayName:
+        description: The display name of the record aggregation definition.
+        type: string
+      message:
+        description: The message accompanying the HTTP response code.
+        type: string
+      rows:
+        description: List of rolled up records that are represented as rows of a table.
+        type: array
+        items:
+          type: RecordRollupResultRowOutputRepresentation
+      statusCode:
+        description: The HTTP response code.
+        type: string
+      totalResultCount:
+        description: The total number of record rollup results.
+        type: integer
+  RecordRollupResultRowOutputRepresentation:
+    description: Represents the output for fetching Record Rollup Results
+    type: object
+    properties:
+      rowData:
+        description: A map of key value, where key is the column api name, and value
+          is the object’s raw value.
+        type: object
+        properties:
+          //:
+            type: any
+
+/connect:
+  /record-aggregation:
+    post:
+      displayName: postRecordAggregationCreation
+      description: API to create a Record Rollup Definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecordAggregationCreationOutputRepresentation
+      body:
+        application/json:
+          type: RecordAggregationCreationInputRepresentation
+          (oas-body-name): recordAggregationPostInput
+    /utilities/applicable-objects:
+      get:
+        displayName: getRecordAggregationApplicableObjects
+        description: Get a List of Applicable Objects for Record Rollups
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationApplicableObjectsOutputRepresentation
+    /{recordAggregationDefinitionId}:
+      put:
+        displayName: putRecordAggregationDefinition
+        description: API to update data in Record Aggregation framework entities
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordAggregationUpdationOutputRepresentation
+        body:
+          application/json:
+            type: RecordAggregationUpdationInputRepresentation
+            (oas-body-name): recordAggregationPutInput
+      uriParameters:
+        recordAggregationDefinitionId:
+          description: ID of the Record Aggregation Definition
+          type: string
+          required: true
+    /{recordAggregationDefinitionId}/record-rollup-results:
+      post:
+        displayName: postGenerateRecordRollupResult
+        description: Get Record Aggregation Results API
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecordRollupResultOutputRepresentation
+        queryParameters:
+          anchorRecordId:
+            description: ID of the record to which the grouped records are rolled
+              up to.
+            type: string
+            required: false
+        body:
+          application/json:
+            type: RecordRollupResultInputRepresentation
+            (oas-body-name): recordAggregationResultInput
+      uriParameters:
+        recordAggregationDefinitionId:
+          description: ID of the record aggregation definition.
+          type: string
+          required: true

package/src/raml/luvio.raml

@@ -0,0 +1,48 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'RecordAggregation'
+(luvio.ttl): 360000
+
+types:
+  RecordAggregationApplicableObjectOutputRepresentation:
+    (luvio.ttl): 1000
+  RecordAggregationApplicableObjectsOutputRepresentation:
+    (luvio.ttl): 1000
+  RecordAggregationCreationOutputRepresentation:
+    (luvio.ttl): 0
+    (luvio.key):
+      id: recordAggregationDefinitionId
+  RecordAggregationUpdationOutputRepresentation:
+    (luvio.ttl): 0
+    (luvio.key):
+      id: statusCode
+  RecordRollupResultColumnOutputRepresentation:
+    (luvio.ttl): 1000
+  RecordRollupResultOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.key):
+      id: definitionDisplayName
+  RecordRollupResultRowOutputRepresentation:
+    (luvio.ttl): 1000
+
+/connect:
+  /record-aggregation:
+    post:
+      (luvio.adapter):
+        name: postRecordAggregationCreation
+  /record-aggregation/utilities/applicable-objects:
+    get:
+      (luvio.adapter):
+        name: getRecordAggregationApplicableObjects
+  /record-aggregation/{recordAggregationDefinitionId}:
+    put:
+      (luvio.adapter):
+        name: putRecordAggregationDefinition
+  /record-aggregation/{recordAggregationDefinitionId}/record-rollup-results:
+    post:
+      (luvio.adapter):
+        name: postGenerateRecordRollupResult