@salesforce/lds-adapters-industries-decisiontable 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,599 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  DecisionTableDefinitionOutputRepresentation:
+    description: Represents the decision table definition
+    type: object
+    properties:
+      collectOperator:
+        description: Collect operator used in case of Collect Hit Policy
+        type: string
+        required: false
+        enum:
+          - Count
+          - Maximum
+          - Minimum
+          - None
+          - Sum
+      conditionCriteria:
+        description: The custom logic that's used to decide how the input fields are
+          processed
+        type: string
+        required: false
+      conditionType:
+        description: The condition logic that's used for input fields
+        type: string
+        required: false
+        enum:
+          - All
+          - Any
+          - Custom
+      decisionResultPolicy:
+        description: Hit policy to specify what will be the result of the decision
+          table
+        type: string
+        required: false
+        enum:
+          - AnyValue
+          - CollectOperator
+          - FirstMatch
+          - OutputOrder
+          - Priority
+          - RuleOrder
+          - UniqueValues
+      description:
+        description: Description of the decision table
+        type: string
+        required: false
+      fullName:
+        description: Unique name of the rule definition
+        type: string
+        required: false
+      id:
+        description: ID of the decision table
+        type: string
+        required: false
+      parameters:
+        description: Represents an array of input fields defined for the decision
+          table
+        type: array
+        items:
+          type: DecisionTableParameterOutputRepresentation
+      setupName:
+        description: Name of the decision table
+        type: string
+        required: false
+      sourceCriteria:
+        description: Output array representation of source filters fieldName, operators,
+          valueType etc.
+        type: array
+        items:
+          type: DecisionTableSourceCriteriaOutputRepresentation
+      sourceObject:
+        description: The Object on which the decision table is based
+        type: string
+        required: false
+      sourceType:
+        description: The source from where decision table data is sourced
+        type: string
+        required: false
+        enum:
+          - CsvUpload
+          - MultipleSobjects
+          - SingleSobject
+      sourceconditionLogic:
+        description: Custom logic that's used to decide how criteria on source is
+          applied
+        type: string
+        required: false
+      status:
+        description: Status of the decision table
+        type: string
+        required: false
+        enum:
+          - ActivationInProgress
+          - Active
+          - Draft
+          - Inactive
+      usageType:
+        description: The process type that uses this decision table
+        type: string
+        required: false
+        enum:
+          - AiAcceleratorSubscriberChurnPrediction
+          - Bre
+          - CustomLoyalty
+          - DefaultPricing
+          - Pricing
+          - ProductCategoryQualification
+          - ProductEligibility
+          - ProductQualification
+          - RecordAlert
+          - ShipAndDebit
+          - TestProcess
+          - TierProcessing
+          - TransactionJournal
+          - WarrantyClaim
+  DecisionTableOutputRepresentation:
+    description: Represents the decision table creation/fetch/delete response and
+      its status
+    type: object
+    properties:
+      code:
+        description: Represents the Error Code if Decision Table Definition creation
+          failed for any reason.
+        type: string
+        required: false
+      decisionTable:
+        description: Represents the Decision Table Definition Output Representation
+          type
+        type: DecisionTableDefinitionOutputRepresentation
+      isSuccess:
+        description: Returns TRUE or FALSE depending on Decision Table Definition
+          creation is successful or some error encountered.
+        type: boolean
+        required: false
+      message:
+        description: Represents the Error Message if Transaction failed for any reason.
+        type: string
+        required: false
+  DecisionTableRowInputRepresentation:
+    description: Represents the information required to update or delete a row
+    type: object
+    properties:
+      action:
+        description: Represents the action to this Decision Table Row, null if is
+          add
+        type: string
+      id:
+        description: Represents the id of the Decision Table Row, null it if is a
+          new row
+        type: string
+      rowData:
+        description: Represents the key value pair of the Decision Table Row.
+        type: object
+        properties:
+          //:
+            type: any
+  DecisionTableRowsListInputRepresentation:
+    description: Represents the information to update the rows in CSV based Decision
+      Table
+    type: object
+    properties:
+      rows:
+        description: Represents a list of rows to be updated
+        type: array
+        items:
+          type: DecisionTableRowInputRepresentation
+        required: false
+  DecisionTableFileInputRepresentation:
+    description: Represents the information to upload file in CSV based Decision Table
+    type: object
+    properties:
+      deleteAllRows:
+        description: Specifies if rows should be deleted
+        type: boolean
+        required: false
+      fileId:
+        description: Represents the id of the CSV file
+        type: string
+  DecisionTableParameterOutputRepresentation:
+    description: Represents the decision table parameter
+    type: object
+    properties:
+      columnMapping:
+        description: Specifies the source object path for the mapping to the column
+          of an entity
+        type: string
+        required: false
+      dataType:
+        description: Data Type of the field used
+        type: string
+        required: false
+        enum:
+          - Boolean
+          - Currency
+          - Date
+          - Number
+          - Percent
+          - String
+      decimalScale:
+        description: Precision of the field used
+        type: integer
+        required: false
+      domainEntity:
+        description: Specifies the entity domain field is mapped to
+        type: string
+        required: false
+      fieldName:
+        description: The name of the field to be used in the decision table
+        type: string
+        required: false
+      isGroupByField:
+        description: Indicates whether the field is used to group the business rules
+          of the decision table
+        type: boolean
+        required: false
+      isPriority:
+        description: Whether it is priority field or not
+        type: boolean
+        required: false
+      isRequired:
+        description: Valid operators for a field based on its usage
+        type: boolean
+        required: false
+      maxlength:
+        description: Maximum length of the field used
+        type: integer
+        required: false
+      operator:
+        description: Indicates whether the field is mandatory to be provided during
+          lookup for hashing column data
+        type: string
+        required: false
+        enum:
+          - Between
+          - DoesNotExistIn
+          - Equals
+          - ExistsIn
+          - GreaterOrEqual
+          - GreaterThan
+          - LessOrEqual
+          - LessThan
+          - Matches
+          - NotEquals
+      sequence:
+        description: The sequence in which input fields are processed.
+        type: integer
+        required: false
+      sortType:
+        description: Specifies the type of sorting done on the rows of a decision
+          table
+        type: string
+        required: false
+        enum:
+          - AscNullFirst
+          - AscNullLast
+          - DescNullFirst
+          - DescNullLast
+          - None
+      usage:
+        description: A picklist to select whether a particular field will be used
+          as input or output
+        type: string
+        required: false
+        enum:
+          - Input
+          - Output
+  DecisionTableSourceCriteriaOutputRepresentation:
+    description: Represents the decision table source criteria
+    type: object
+    properties:
+      operator:
+        description: Specifies the operator used in the filter criteria
+        type: string
+        required: false
+        enum:
+          - DoesNotExistIn
+          - Equals
+          - ExistsIn
+          - GreaterOrEqual
+          - GreaterThan
+          - LessOrEqual
+          - LessThan
+          - Matches
+          - NotEquals
+      sequenceNumber:
+        description: The sequence number of the filter criteria in the associated
+          decision table source condition
+        type: integer
+        required: false
+      sourceFieldName:
+        description: The name of the field that's used in the filter criteria
+        type: string
+        required: false
+      value:
+        description: The expected value of the field
+        type: string
+        required: false
+      valueType:
+        description: Specifies the type of filter value
+        type: string
+        required: false
+        enum:
+          - Formula
+          - Literal
+          - Lookup
+          - Parameter
+          - PickList
+  DecisionTableTemplateDefinitionOutputRepresentation:
+    description: Represents the decision table template fetch response
+    type: object
+    properties:
+      decisionTableTemplate:
+        description: Represents the Decision Table Definition Output Representation
+          type
+        type: DecisionTableDefinitionOutputRepresentation
+        required: false
+      errors:
+        description: Represents the Errors if Decision Table Definition creation failed
+          for any reason.
+        type: array
+        required: false
+        items:
+          type: ErrorOutputRepresentation
+  DecisionTableTemplateOutputRepresentation:
+    description: Representation of a Decision Table Template
+    type: object
+    properties:
+      location:
+        description: location /namespace of the template
+        type: string
+        required: false
+      templateName:
+        description: Display name of template
+        type: string
+        required: false
+      usageType:
+        description: Usage type used for the template
+        type: string
+        required: false
+  ErrorParametersOutputRepresentation:
+    description: Representation of parameters part of the error
+    type: object
+    properties:
+      name:
+        description: Represents the name of the error parameter
+        type: string
+        required: false
+      value:
+        description: Represents the value of the error parameter
+        type: string
+        required: false
+  ErrorTargetsOutputRepresentation:
+    description: Representation of targets part of the error
+    type: object
+    properties:
+      reference:
+        description: Represents the reference to the error target
+        type: string
+        required: false
+      type:
+        description: Represents the type of the error target
+        type: string
+        required: false
+  ErrorOutputRepresentation:
+    description: Representation of error as per salesforce standardised template
+    type: object
+    properties:
+      errorCode:
+        description: Represents the error code
+        type: string
+        required: false
+      message:
+        description: Represents the message for the error
+        type: string
+        required: false
+      messageCode:
+        description: Represents the message code for the error
+        type: string
+        required: false
+      parameters:
+        description: Represents the parameters of the error
+        type: array
+        required: false
+        items:
+          type: ErrorParametersOutputRepresentation
+      targets:
+        description: Represents the targets of the error
+        type: array
+        required: false
+        items:
+          type: ErrorTargetsOutputRepresentation
+  DecisionTableTemplatesListOutputRepresentation:
+    description: Representation of a List of Decision Table Templates
+    type: object
+    properties:
+      decisionTableTemplates:
+        description: Represents the Decision Table Template Output Representation
+        type: array
+        required: false
+        items:
+          type: DecisionTableTemplateOutputRepresentation
+      errors:
+        description: Represents the Errors if Decision Table Template List retrieval
+          failed for any reason.
+        type: array
+        required: false
+        items:
+          type: ErrorOutputRepresentation
+  DecisionTableDataOutputRepresentation:
+    description: Representation of the status of an action performed
+    type: object
+    properties:
+      errorFileId:
+        description: Represents the Error Code if Transaction failed for any reason.
+        type: string
+      errors:
+        description: Represents the list of Error Messages if Transaction failed for
+          any reason.
+        type: array
+        items:
+          type: string
+        required: false
+  DecisionTableRowOutputRepresentation:
+    description: Represents the information to describe a Decision Table Row for output.
+    type: object
+    properties:
+      id:
+        description: Represents the id of the Decision Table Row.
+        type: string
+      rowData:
+        description: Represents the key value pair of the Decision Table Row.
+        type: object
+        properties:
+          //:
+            type: any
+  DecisionTableRowsListOutputRepresentation:
+    description: Representation of the rows in Relation to the Decision Table, including
+      current state of pagination
+    type: object
+    properties:
+      rows:
+        description: Represents the returned list of rows.
+        type: array
+        items:
+          type: DecisionTableRowOutputRepresentation
+      totalRows:
+        description: Represents the total number of rows.
+        type: integer | nil
+  DecisionTableFileOutputRepresentation:
+    description: Representation of the status of an action performed
+    type: object
+    properties:
+      message:
+        description: Represents the Error Message if Transaction failed for any reason.
+        type: string
+/connect:
+  /business-rules/decision-table:
+    /definitions/{decisionTableId}:
+      get:
+        displayName: getDecisionTable
+        description: Get information about decision table details.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DecisionTableOutputRepresentation
+
+      uriParameters:
+        decisionTableId:
+          type: string
+          required: true
+    /templates:
+      get:
+        displayName: getDecisionTableTemplateList
+        description: Get the decision table templates list
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: DecisionTableTemplatesListOutputRepresentation
+        queryParameters:
+          usageType:
+            type: string
+            required: false
+      /{templateName}:
+        get:
+          displayName: getDecisionTableTemplate
+          description: Get the decision table template definition
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DecisionTableTemplateDefinitionOutputRepresentation
+        uriParameters:
+          templateName:
+            type: string
+            required: true
+    /{decisionTableId}:
+      /data:
+        post:
+          displayName: postDecisionTableRows
+          description: POST Resource method to update Rows in a CSV Based Decision Table.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DecisionTableDataOutputRepresentation
+          body:
+            application/json:
+              type: DecisionTableRowsListInputRepresentation
+              (oas-body-name): rowsInput
+        uriParameters:
+          decisionTableId:
+            description: Unique ID used to represent a decision table.
+            type: string
+            required: true
+
+        get:
+          displayName: getDecisionTableRows
+          description: Get a list of rows or generate a csv file of rows in a Decision
+            Table.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DecisionTableRowsListOutputRepresentation
+          queryParameters:
+            filter:
+              type: string
+              required: false
+            limit:
+              type: integer
+              required: false
+            offset:
+              type: integer
+              required: false
+      /file:
+        get:
+          displayName: getDecisionTableFile
+          description: Generate a csv file of rows in a Decision Table.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DecisionTableFileOutputRepresentation
+          queryParameters:
+            filter:
+              type: string
+              required: false
+        post:
+          displayName: postDecisionTableFile
+          description: POST Resource method to upload file in a CSV Based Decision
+            Table.
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: DecisionTableFileOutputRepresentation
+          body:
+            application/json:
+              type: DecisionTableFileInputRepresentation
+              (oas-body-name): fileInput
+        uriParameters:
+          decisionTableId:
+            description: Unique ID used to represent a decision table.
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,82 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'DecisionTable'
+(luvio.ttl): 360000
+
+types:
+  DecisionTableOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableDefinitionOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableParameterOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableSourceCriteriaOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableTemplateDefinitionOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableTemplateOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ErrorParametersOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ErrorTargetsOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  ErrorOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableTemplatesListOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableDataOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      errorFileId: errorFileId
+  DecisionTableRowsListOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  DecisionTableFileOutputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      message: message
+/connect:
+  /business-rules/decision-table:
+    /definitions/{decisionTableId}:
+      get:
+        (luvio.adapter):
+          name: getDecisionTable
+    /templates:
+      get:
+        (luvio.adapter):
+          name: getDecisionTableTemplateList
+    /templates/{templateName}:
+      get:
+        (luvio.adapter):
+          name: getDecisionTableTemplate
+    /{decisionTableId}:
+      /data:
+        post:
+          (luvio.adapter):
+            name: postDecisionTableRows
+        get:
+          (luvio.adapter):
+            name: getDecisionTableRows
+      /file:
+        post:
+          (luvio.adapter):
+            name: postDecisionTableFile
+        get:
+          (luvio.adapter):
+            name: getDecisionTableFile