@salesforce/lds-adapters-industries-actionablelist 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,481 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  ALDDatasetColumnOutputRepresentation:
+    description: Output representation of dataset column for particular actionable
+      list definition
+    type: object
+    properties:
+      actionableListDefinitionId:
+        description: The actionable list definition that is mapped to the dataset
+          column
+        type: string
+      dataDomain:
+        description: The data domain that is mapped to the data type of the dataset
+          column
+        type: string | nil
+      dataType:
+        description: The data type used for formatting
+        type: string | nil
+      id:
+        description: Id of actionable list definition dataset column
+        type: string
+      isDefault:
+        description: Flag to denote if this particular column has been made available
+          or not
+        type: boolean
+      objectName:
+        description: The object name that is mapped to the dataset column
+        type: string | nil
+      sourceColumnApiName:
+        description: The column api information from tcrm side
+        type: string | nil
+      sourceFieldName:
+        description: Source field name of actionable list definition dataset column
+        type: string | nil
+  ALDMemberStatusOutputRepresentation:
+    description: Output representation of member status for particular actionable
+      list definition
+    type: object
+    properties:
+      iconName:
+        description: Icon name of actionable list definition member status
+        type: string
+      id:
+        description: Id of actionable list definition member status
+        type: string
+      status:
+        description: Status for particular actionable list definition member
+        type: string
+  ActionableListDefinitionCreateInputRepresentation:
+    description: Input representation for create actionable list definition API
+    type: object
+    properties:
+      developerName:
+        description: Set developer name for create actionable list definition
+        type: string
+      label:
+        description: Set label for create actionable list definition
+        type: string
+      objectName:
+        description: Set anchor entity for create actionable list definition
+        type: string
+  ActionableListDefinitionCreateOutputRepresentation:
+    description: Output representation for create actionable list definition API
+    type: object
+    properties:
+      actionableListDefinition:
+        description: Created actionable list definition
+        type: ActionableListDefinitionOutputRepresentation
+      status:
+        description: Status of create actionable list definition API
+        type: ActionableListDefinitionStatusOutputRepresentation
+  ActionableListDefinitionGetAllOutputRepresentation:
+    description: Output representation for get actionable list definition API
+    type: object
+    properties:
+      aldList:
+        description: List of all actionable list definitions
+        type: array
+        items:
+          type: ActionableListDefinitionOutputRepresentation
+  ActionableListDefinitionOutputRepresentation:
+    description: Output representation of single object for get actionable list definition
+      API
+    type: object
+    properties:
+      aldDatasetColumnOutputRepresentation:
+        description: Information about all dataset columns for this actionable list
+          definition
+        type: array
+        items:
+          type: ALDDatasetColumnOutputRepresentation
+      aldMemberStatusOutputRepresentation:
+        description: Information about all member status for this actionable list
+          definition
+        type: array
+        items:
+          type: ALDMemberStatusOutputRepresentation
+      batchCalcJobDefinitionId:
+        description: BatchCalcJobDefinitionId of DPE definition
+        type: string | nil
+      fullName:
+        description: Full Name of actionable list definition
+        type: string
+      id:
+        description: Id of actionable list definition
+        type: string
+      isActive:
+        description: Flag to determine whether the actionable list definition is active
+          or not
+        type: boolean
+      objectName:
+        description: Anchor object name of actionable list definition
+        type: string
+      status:
+        description: Status of actionable list definition on DPE side
+        type: string
+      tcrmDatasetId:
+        description: TCRM dataset id of dataset created on tcrm side
+        type: string | nil
+      tcrmDatasetName:
+        description: TCRM dataset name of dataset created on tcrm side
+        type: string
+  ActionableListDefinitionStatusOutputRepresentation:
+    description: Output representation to display the status of an API request
+    type: object
+    properties:
+      code:
+        description: get status code
+        type: integer
+      message:
+        description: get status message
+        type: string
+  ActionableListMembersOutputRepresentation:
+    description: Fetch existing members from Actionable List
+    type: object
+    properties:
+      memberIds:
+        description: A list of Ids of members in a actionableList
+        type: array
+        items:
+          type: string
+  ActionableListDatasetByDefinitionRepresentation:
+    description: Fetch rows from dataset
+    type: object
+    properties:
+      count:
+        description: Count of records in query result
+        type: integer | nil
+      currencyCode:
+        description: Currency code of the currency fields in dataset
+        type: string | nil
+      datasetColumns:
+        description: A list of dataset columns information in a actionableList
+        type: array
+        items:
+          type: ActionableListDatasetColumnRepresentation
+      datasetRows:
+        description: A list of dataset rows with column information in a actionableList
+        type: array
+        items:
+          type: ActionableListDatasetRowRepresentation
+      memberStatuses:
+        description: A list of member status in a actionableList
+        type: array
+        items:
+          type: ActionableListMemberStatusRepresentation
+      responseId:
+        description: Stores the response Id of the TCRM result set
+        type: string
+  ActionableListDatasetColumnRepresentation:
+    description: Output representation to display actionable List dataset columns
+    type: object
+    properties:
+      dataDomain:
+        description: get data domain
+        type: string | nil
+      dataType:
+        description: The data type used for formatting
+        type: string | nil
+      isDefault:
+        description: flag to denote if this particular column has been made available
+          or not
+        type: boolean | nil
+      objectName:
+        description: get Object Name
+        type: string | nil
+      sourceColumnApiName:
+        description: get source Column Api name
+        type: string | nil
+      sourceFieldName:
+        description: get soureField name
+        type: string | nil
+  ActionableListDatasetInputRepresentation:
+    description: Input representation to fetch dataset rows and columns of Actionable
+      List
+    type: object
+    properties:
+      actionableListDefinitionId:
+        description: Id of the actionable list definition record
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      filterLogic:
+        description: Filter Logic that is used to create the dataset query
+        required: false # TODO handrolled W-9314597
+        type: string
+      filters:
+        description: filter by clause list
+        required: false # TODO handrolled W-9314597
+        type: object
+      offset:
+        description: Offset of dataset rows
+        type: integer | nil
+        required: false # TODO handrolled W-9314597
+      orderBy:
+        description: order by clause in query while fetching dataset rows
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      queryType:
+        description: Query type decides if this is a count query or records query
+          etc
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      rowLimit:
+        description: Limit of dataset rows
+        type: integer | nil
+        required: false # TODO handrolled W-9314597
+      shouldReturnCurrencyCode:
+        description: Should the API return Currency Code used for formatting
+        type: boolean
+        required: false # TODO handrolled W-9314597
+      sortOrder:
+        description: ASC or DESC order while fetching dataset rows
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+  ActionableListDatasetRowRepresentation:
+    description: Output representation to display actionable List dataset rows
+    type: object
+    properties:
+      rowMap:
+        description: get row Map to fetch Id
+        type: object
+        properties:
+          //:
+            type: string
+  ActionableListFilterInputRepresentation:
+    description: Input representation for actionable list Filters.
+    type: object
+    properties:
+      columnName:
+        description: Name of Column to be filtered
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      dataDomain:
+        description: data domain of filter column
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      operator:
+        description: operator for filter
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      value:
+        description: value for filter
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+  ActionableListFilterInputRepresentationList:
+    description: Input representation for a list of filters
+    type: object
+    properties:
+      actionableListFilterList:
+        description: filter clauses list
+        required: false # TODO handrolled W-9314597
+        type: array
+        items:
+          type: object
+  ActionableListMemberStatusRepresentation:
+    description: Output representation to display actionable List member status
+    type: object
+    properties:
+      iconName:
+        description: get icon name
+        type: string | nil
+      id:
+        description: get id
+        type: string | nil
+      status:
+        description: get status
+        type: string | nil
+  ActionableListUpsertInputRepresentation:
+    description: Input representation for upsert Actionable List with it's members
+      and columns
+    type: object
+    properties:
+      actionableListColumns:
+        description: Upsert actionable list columns of actionable list
+        required: false # TODO handrolled W-9314597
+        type: array
+        items:
+          type: string
+      actionableListDefinitionId:
+        description: Upsert actionable list definition id of actionable list
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      actionableListMemberIds:
+        description: Upsert actionable list members of actionable list
+        required: false # TODO handrolled W-9314597
+        type: array
+        items:
+          type: string
+      defaultMemberStatusId:
+        description: Upsert default member status Id of actionable list
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      description:
+        description: Upsert description of actionable list
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      filterLogic:
+        description: Filter Logic used in dataset query in Async members addition to Actionable List
+        type: string
+        required: false # TODO handrolled W-9314597
+      filters:
+        description: Filters used in Async members addition to Actionable List
+        required: false # TODO handrolled W-9314597
+        type: object
+      id:
+        description: Id to upsert the actionable list record
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      isAsync:
+        description: Should the upsert be async or sync
+        type: boolean
+        required: false # TODO handrolled W-9314597
+      name:
+        description: Upsert name of actionable list
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+      objectName:
+        description: Upsert object name of actionable list
+        type: string | nil
+        required: false # TODO handrolled W-9314597
+  ActionableListUpsertOutputRepresentation:
+    description: Upsert Actionable List and it's members and columns
+    type: object
+    properties:
+      errorMessage:
+        description: Error message while upserting actionable list
+        type: string | nil
+      id:
+        description: Id of actionable list
+        type: string | nil
+      isSuccess:
+        description: Flag to detonate that actionable list successfully upserted
+        type: string | nil
+  # TODO Hand-rolled W-11954472: ActionableListDefinitionWrapperInputRepresentation added manually
+  ActionableListDefinitionWrapperInputRepresentation:
+    description: wrapper of ActionableListDefinitionCreateInputRepresentation
+    type: object
+    properties:
+      actionableListDefinitionCreateInput:
+        description: Input representation for ActionableListDefinitionCreateInputRepresentation
+        type: ActionableListDefinitionCreateInputRepresentation
+  # TODO Hand-rolled W-11954472: ActionableListWrapperInputRepresentation added manually
+  ActionableListWrapperInputRepresentation:
+    description: wrapper of ActionableListUpsertInputRepresentation
+    type: object
+    properties:
+      actionableListUpsertInput:
+        description: Input representation for ActionableListUpsertInputRepresentation
+        type: ActionableListUpsertInputRepresentation
+  # TODO Hand-rolled W-11954472: ActionableListDatasetWrapperInputRepresentation added manually
+  ActionableListDatasetWrapperInputRepresentation:
+    description: wrapper of ActionableListDatasetInputRepresentation
+    type: object
+    properties:
+      actionableListDataset:
+        description: Input representation for ActionableListDatasetInputRepresentation
+        type: ActionableListDatasetInputRepresentation
+/connect:
+  /actionable-list-definition:
+    get:
+      description: Fetch all available actionable list definitions if id is not present
+        in query param
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListDefinitionGetAllOutputRepresentation
+      queryParameters:
+        id:
+          type: string
+          required: false
+        isActive:
+          type: boolean
+          required: false
+        limit:
+          type: integer
+          required: false
+        offset:
+          type: integer
+          required: false
+    post:
+      description: API to create actionable list definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListDefinitionCreateOutputRepresentation
+      body:
+        application/json:
+          type: ActionableListDefinitionWrapperInputRepresentation
+          # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): actionableListDefinitionCreateInput
+  /actionable-list/{id}/members:
+    get:
+      description: Get an ActionableList’s Members
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListMembersOutputRepresentation
+    uriParameters:
+      id:
+        type: string
+        required: true
+  /actionable-list:
+    post:
+      description: API to upsert actionable list and it's members and columns
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListUpsertOutputRepresentation
+      body:
+        application/json:
+          type: ActionableListWrapperInputRepresentation
+          # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): actionableListUpsertInput
+  /actionable-list-definition/rows:
+    post:
+      description: API to list actionable Dataset rows and columns of the actionable
+        list Definition
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ActionableListDatasetByDefinitionRepresentation
+      body:
+        application/json:
+          type: ActionableListDatasetWrapperInputRepresentation
+          # TODO [W-11954472]: Hand Rolled Change that removed 'required: false' since the 'required' property is not allowed in RAML 1.0
+          (oas-body-name): actionableListDataset

package/src/raml/luvio.raml

@@ -0,0 +1,54 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'actionablelist'
+(luvio.ttl): 360000
+
+types:
+  ALDDatasetColumnOutputRepresentation:
+    (luvio.ttl): 100
+  ALDMemberStatusOutputRepresentation:
+    (luvio.ttl): 100
+  ActionableListDefinitionCreateOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: actionableListDefinition.id
+  ActionableListDefinitionGetAllOutputRepresentation:
+    (luvio.ttl): 100
+  ActionableListDefinitionOutputRepresentation:
+    (luvio.ttl): 100
+  ActionableListDefinitionStatusOutputRepresentation:
+    (luvio.ttl): 100
+  ActionableListMembersOutputRepresentation:
+    (luvio.ttl): 100
+  ActionableListDatasetByDefinitionRepresentation:
+    (luvio.ttl): 100
+  ActionableListUpsertOutputRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: id
+
+/connect:
+  /actionable-list-definition:
+    get:
+      (luvio.adapter):
+        name: getActionableListDefinitions
+    post:
+      (luvio.adapter):
+        name: createActionableListDefinition
+  /actionable-list/{id}/members:
+    get:
+      (luvio.adapter):
+        name: getActionableListMembers
+  /actionable-list:
+    post:
+      (luvio.adapter):
+        name: upsertActionableList
+  /actionable-list-definition/rows:
+    post:
+      (luvio.adapter):
+        name: getActionableListDatasetInfo
+      (luvio.method): get