@salesforce/lds-adapters-industries-einstein-aiaccelerator 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,705 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  Column:
+    description: .
+    type: object
+    properties:
+      columnLabel:
+        description: .
+        type: string | nil
+        required: false
+      columnName:
+        description: .
+        type: string | nil
+        required: false
+      columnValue:
+        description: .
+        type: string | nil
+        required: false
+      initialValue:
+        description: .
+        type: string | nil
+        required: false
+  # TODO Hand-rolled Union Types for Array  W-8253396
+  NullableColumnMap:
+    description: ColumnMapWrap wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      //:
+        type: string | nil
+  ColumnMapWrap:
+    description: ColumnMapWrap wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      columnMap:
+        description: Map of the Field Map.
+        type: NullableColumnMap | nil
+  FeatureExtractionParametersList:
+    description: featureExtractionParametersList wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      featureExtractionParameters:
+        description: FeatureExtractionParameters
+        type: array
+        items:
+          type: FeatureExtractionParametersMapValue | nil # TODO Hand-rolled W-7093257
+        required: false
+    # TODO Hand-rolled Union Types for Array  W-8253396
+  NullableFeatureExtractionParametersMapValue:
+    description: Wrapper to make the object null
+    type: object
+  FeatureExtractionParametersMapValue:
+    description: featureExtractionParameterMapValue wrapper object for use as child
+      wrapper of FeatureExtractionParametersMap.
+    type: object
+    properties:
+      featureExtractionParametersMapValue:
+        description: Map of the Field Map.
+        type: NullableFeatureExtractionParametersMapValue | nil # TODO Hand-rolled W-7093257
+        required: false
+  Insight:
+    description: .
+    type: object
+    properties:
+      columns:
+        description: .
+        type: array
+        items:
+          type: Column | nil
+        required: false
+      value:
+        description: .
+        format: double
+        type: number
+        required: false
+    # TODO Hand-rolled Union Types for Array  W-8253396
+  NullableInsightsSettingsMap:
+    description: Wrapper for Nullable Map Object.
+    type: object
+    properties:
+      //:
+        type: integer | nil
+  InsightsSettingsMap:
+    description: InsightsSettingsMap wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      insightsSettings:
+        description: insightsSettings
+        type: NullableInsightsSettingsMap | nil
+        required: false
+  ModelFeature:
+    description: .
+    type: object
+    properties:
+      label:
+        description: Model field label
+        type: string | nil
+        required: false
+      name:
+        description: Model field name
+        type: string | nil
+        required: false
+      type:
+        description: Model field type
+        type: string | nil
+        required: false
+  Prediction:
+    description: .
+    type: object
+    properties:
+      historyRefPointScore:
+        description: .
+        format: double
+        type: number
+        required: false
+      insights:
+        description: .
+        type: array
+        items:
+          type: Insight | nil
+        required: false
+      missingColumns:
+        description: .
+        type: array
+        items:
+          type: string | nil
+        required: false
+      outOfBoundsColumns:
+        description: .
+        type: array
+        items:
+          type: Column | nil
+        required: false
+      score:
+        description: .
+        format: double
+        type: number
+        required: false
+  PredictionInputWrapperRepresentation:
+    description: Wrapper for PredictInputRepresentation.
+    type: object
+    properties:
+      predictionInput:
+        description: oas body name.
+        type: PredictionInputRepresentation
+  PredictionInputRepresentation:
+    description: Request for which predictions are fetched.
+    type: object
+    properties:
+      async:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      columnNames:
+        description: .
+        type: WrappedList | nil
+        required: false # TODO Hand-rolled W-9314597
+      enableFeaturePersistence:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enableInsightPersistence:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enableScorePersistence:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enableSuggestionPersistence:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enrichModelClassification:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enrichModelFeatures:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      enrichPredictionDefinition:
+        description: .
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      featureColumnMap:
+        description: .
+        type: ColumnMapWrap | nil
+        required: false # TODO Hand-rolled W-9314597
+      featureExtractionParameters:
+        description: .
+        type: FeatureExtractionParametersList | nil
+        required: false # TODO Hand-rolled W-9314597
+      featureExtractorId:
+        description: .
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      historyReferencePoint:
+        description: .
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      inputType:
+        description: .
+        type: string
+        required: true # TODO Hand-rolled W-9314597
+      insightColumnMap:
+        description: .
+        type: ColumnMapWrap | nil
+        required: false # TODO Hand-rolled W-9314597
+      insightsSettings:
+        description: .
+        type: InsightsSettingsMap | nil
+        required: false # TODO Hand-rolled W-9314597
+      predictionDefinition:
+        description: .
+        type: string
+        required: true # TODO Hand-rolled W-9314597
+      rawData:
+        description: .
+        type: RawDataList | nil
+        required: false # TODO Hand-rolled W-9314597
+      records:
+        description: .
+        type: WrappedList | nil
+        required: false # TODO Hand-rolled W-9314597
+      scorePersistenceColumn:
+        description: .
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      secondaryRecordIdPersistenceField:
+        description: .
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      suggestionColumnMap:
+        description: .
+        type: ColumnMapWrap | nil
+        required: false # TODO Hand-rolled W-9314597
+      usecaseDefinition:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      usecaseDevName:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      featureExtractorDevName:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+
+    # TODO Hand-rolled Union Types for Array  W-8253396
+  NullableModel:
+    description: .
+    type: object
+    properties:
+      //:
+        type: string | nil
+  PredictionObject:
+    description: .
+    type: object
+    properties:
+      model:
+        description: .
+        type: NullableModel | nil
+        required: false
+      prediction:
+        description: .
+        type: Prediction | nil
+        required: false
+      status:
+        description: .
+        type: string | nil
+      suggestions:
+        description: .
+        type: array
+        items:
+          type: Suggestion | nil
+        required: false
+  PredictionOutputRepresentation:
+    description: Predictions for a given request
+    type: object
+    properties:
+      classificationThreshold:
+        description: Classification Threshold Value
+        format: double
+        type: number
+        required: false
+      classificationType:
+        description: Classification model type
+        type: string | nil
+        required: false
+      executionModeWarning:
+        description: Indicates the change in execution mode from user specified to
+          default mode configuration
+        type: string | nil
+        required: false
+      featureExtractor:
+        description: Indicates Feature Extractor Implementation class used for a request
+        type: string | nil
+        required: false
+      featureExtractorType:
+        description: Indicates Feature Extractor Type used for a request
+        type: string | nil
+        required: false
+      inputType:
+        description: .
+        type: string | nil
+        required: false
+      insightsSettings:
+        description: .
+        type: object
+        properties:
+          //:
+            type: integer
+        required: false
+      modelFeatures:
+        description: Columns + values that are out of bounds. These values were not
+          used when training the model
+        type: array
+        items:
+          type: ModelFeature | nil
+        required: false
+      outcomeGoal:
+        description: Indicates whether predDef maximizes or minimizes the field value.
+        type: string | nil
+        required: false
+      predictionDefinition:
+        description: .
+        type: string | nil
+        required: false
+      predictionDefinitionLabel:
+        description: Label corresponding to the prediction definiton ID used for prediction
+        type: string | nil
+        required: false
+      predictionPersistenceErrorMessage:
+        description: Indicates the condition that all the entities failed to persist
+          via persistence manager
+        type: string | nil
+        required: false
+      predictionPlatform:
+        description: .
+        type: string | nil
+        required: false
+      predictionPurpose:
+        description: .
+        type: string | nil
+        required: false
+      predictions:
+        description: .
+        type: array
+        items:
+          type: PredictionObject | nil
+        required: false
+      primaryResponseObjRecordIds:
+        description: Indicates the list of recordIds where the response is persisted
+          in primary response object
+        type: array
+        items:
+          type: string | nil
+        required: false
+      requestId:
+        description: .
+        type: string | nil
+        required: false
+      secondaryResponseObjRecordIds:
+        description: Indicates the list of recordIds where the response is persisted
+          in secondary response object
+        type: array
+        items:
+          type: string | nil
+        required: false
+      status:
+        description: Indicates whether the call succeeded or failed, and in case of
+          failure also provides the reason.
+        type: Status
+        required: true
+  Prescription:
+    description: .
+    type: object
+    properties:
+      columns:
+        description: .
+        type: array
+        items:
+          type: Column | nil
+      value:
+        description: .
+        format: double
+        type: number
+  RawDataInputRepresentation:
+    description: RawDataInputRepresentation wrapper object for use as child wrapper
+      of  RawDataRep.
+    type: object
+    properties:
+      rawDataInput:
+        description: RawDataInput
+        type: array
+        items:
+          type: string | nil
+  RawDataInputWrap:
+    description: RawDataInputWrap wrapper object for use as child wrapper of  RawDataList.
+    type: object
+    properties:
+      rawDataInputWrap:
+        type: RawDataInputRepresentation | nil # TODO Hand-rolled W-7093257
+  RawDataList:
+    description: RawDataList wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      rawData:
+        description: RawData
+        type: array
+        items:
+          type: RawDataInputWrap | nil # TODO Hand-rolled W-7093257
+  # TODO Hand-rolled W-10772396
+  Status:
+    description: The output representation of the Status of the request.
+    type: object
+    properties:
+      code:
+        description: get Code.
+        type: integer
+        required: true
+      message:
+        description: Get Error Message
+        type: string
+        required: true
+  Suggestion:
+    description: .
+    type: object
+    properties:
+      columns:
+        description: .
+        type: array
+        items:
+          type: Column | nil
+        required: false
+      value:
+        description: .
+        format: double
+        type: number
+        required: false
+  WrappedList:
+    description: WrappedList wrapper object for use in PredictionInputRepresentation.
+    type: object
+    properties:
+      wrappedList:
+        description: wrappedList
+        type: array
+        items:
+          type: string | nil
+  RecommendationInputWrapperRepresentation:
+    description: Wrapper for RecommendationInputRepresentation.
+    type: object
+    properties:
+      recommendationInput:
+        description: oas body name.
+        type: RecommendationInputRepresentation
+  RecommendationInputRepresentation:
+    description: Request for which recommendations are fetched.
+    type: object
+    properties:
+      isAsync:
+        description: Indicates whether the execution mode is async or not.
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      maxRecommendationsCount:
+        description: The maximum number of recommendations to be requested.
+        type: integer | nil
+        required: false # TODO Hand-rolled W-9314597
+      canPersistRecommendations:
+        description: Indicates whether the recommendations that are fetched are persisted or not.
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+      rcmdRecordIdPersistenceColumn:
+        description: The name of the column from the PrimaryResponse object that persists the recommendation record ID when canPersistRecommendations is set to true.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      recommendationFieldMapping:
+        description: The field mapping that’s used to store the recommendations.
+        type: object
+        properties:
+          //:
+            type: string | nil
+      strategyName:
+        description: The name of the strategy.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      rcmdStrategyParameters:
+        description: The list of parameters to pass to the flow action for the specified strategy to generate recommendations.
+        type: array
+        items:
+          type: any
+        required: false # TODO Hand-rolled W-9314597
+      usecaseDefinitionName:
+        description: The API name of the usecase definition.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+  RecommendationOutputRepresentation:
+    description: Recommendations for a given request
+    type: object
+    properties:
+      executionModeWarning:
+        description: The warning that’s displayed when the execution mode isn’t suitable.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      recommendationPersistenceErrorMessage:
+        description: The error message that’s displayed when the persistence of recommendations fails.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      recommendationRecordIds:
+        description: The list of IDs of the recommendation records that are part of the recommendation result.
+        type: array
+        items:
+          type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      recommendationStrategyResult:
+        description: The recommendation result that’s fetched.
+        type: array
+        items:
+          type: RcmdStrategyResult | nil
+        required: false # TODO Hand-rolled W-9314597
+      requestId:
+        description: The ID of the recommendation request.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: The status of the recommendation request.
+        type: Status
+        required: true # TODO Hand-rolled W-9314597
+      strategyName:
+        description: The name of the strategy.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      usecaseName:
+        description: The usecaseName value on the AIUsecaseDefinition object.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+  Error:
+    description: .
+    type: object
+    properties:
+      message:
+        description: The message that’s displayed for the error.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      statusCode:
+        description: The status code that indicates error.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+  RcmdStrategyResult:
+    description: .
+    type: object
+    properties:
+      errors:
+        description: Runtime errors that occurred during recommendation request execution.
+        type: array
+        items:
+          type: Error | nil
+        required: false # TODO Hand-rolled W-9314597
+      onBehalfOfId:
+        description: The ID of the user or object for which the recommendation request was executed.
+        type: string | nil
+      predictionScore:
+        description: The prediction score that’s an input for the recommendation request.
+        format: double
+        required: false # TODO Hand-rolled W-9314597
+        type: number
+      recommendations:
+        description: The list of recommendations returned by a recommendation request.
+        type: array
+        items:
+          type: Recommendation | nil
+        required: false # TODO Hand-rolled W-9314597
+      recordId:
+        description: The ID of the record for which the recommendation request was executed.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      isSuccess:
+        description: Indicates whether the recommendation request was successful or not.
+        type: boolean | nil
+        required: false # TODO Hand-rolled W-9314597
+  Recommendation:
+    description: .
+    type: object
+    properties:
+      acceptanceLabel:
+        description: Text indicating user acceptance of the recommendation.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      actionStrategyParameters:
+        description: The list of parameters to pass to the flow action based on the user’s acceptance or rejection of the recommendation.
+        type: array
+        items:
+          type: RecommendationActionParam | nil
+        required: false # TODO Hand-rolled W-9314597
+      actionReferenceId:
+        description: The ID of the action to perform, for example, launching a flow.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      actionReferenceLabel:
+        description: .
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      actionReferenceName:
+        description: The name of the action to perform, for example, launching a flow.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      actionType:
+        description: The type of action.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      description:
+        description: The description of the recommendation.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      id:
+        description: The ID of the recommendation.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      imageUrl:
+        description: The URL of the recommendation image to display.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      name:
+        description: The name of the recommendation.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      rejectionLabel:
+        description: Text indicating user rejection of the recommendation
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+  RecommendationActionParam:
+    description: .
+    type: object
+    properties:
+      name:
+        description: The name of the parameter.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      type:
+        description: The type of the parameter.
+        type: string | nil
+        required: false # TODO Hand-rolled W-9314597
+      value:
+        description: The value of the parameter.
+        type: any
+        required: false # TODO Hand-rolled W-9314597
+
+/connect:
+  /aiaccelerator:
+    /predictions:
+      post:
+        description: POST resource to fetch the predictions that need to be performed
+          at the store by the sales rep.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: PredictionOutputRepresentation
+        body:
+          application/json:
+            # TODO Hand-rolled W-10128739. Original type: PredictionInputRepresentation
+            type: PredictionInputWrapperRepresentation
+            (oas-body-name): predictionInput
+    /recommendations:
+      post:
+        description: POST resource to fetch the recommendations that need to be performed
+          at the store by the sales rep.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: RecommendationOutputRepresentation
+        body:
+          application/json:
+            # TODO Hand-rolled W-10128739. Original type: RecommendationInputRepresentation
+            type: RecommendationInputWrapperRepresentation
+            (oas-body-name): recommendationInput