@salesforce/lds-adapters-analytics-wave-private 1.280.0 → 1.282.0

package/src/raml/api.raml

@@ -56,6 +56,127 @@ types:
       query:
         description: The query
         type: string
+  TemplateSetupJobRepresentation:
+    description: The configuration and status of a template setup job.
+    type: object
+    properties:
+      description:
+        description: The job description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The job's last execution time duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      name:
+        description: The job name.
+        type: string
+      status:
+        description: The job's last execution status
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
+      tasks:
+        description: The tasks in this job.
+        type: array
+        items:
+          type: TemplateSetupTaskRepresentation
+  TemplateSetupPlanRepresentation:
+    description: The configuration and current status of a template setup plan.
+    type: object
+    properties:
+      description:
+        description: The setup plan description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      details:
+        description: The task detailed description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The setup plan's last execution duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      jobs:
+        description: The jobs in this plan.
+        type: array
+        items:
+          type: TemplateSetupJobRepresentation
+      name:
+        description: The setup plan name.
+        type: string
+      status:
+        description: The setup plan's last execution status.
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
+      templateId:
+        description: The template id for this setup plan.
+        type: string
+  TemplateSetupTaskRepresentation:
+    description: The configuration and status of a template setup task.
+    type: object
+    properties:
+      description:
+        description: The task description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      details:
+        description: The task detailed description.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      duration:
+        description: The task's last execution time duration.
+        # format: int64
+        # type: integer
+        # TODO Hand-rolled W-8274943
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-8253396
+      enabled:
+        description: Is the resulting setup for this task enabled.
+        type: boolean
+        required: false # TODO Hand-rolled W-8253396
+      error:
+        description: Any error message if the task's last execution failed.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      name:
+        description: The task name.
+        type: string
+      setupUrl:
+        description: The url or url path to perform the task configuration manually.
+          Typically only shown on error.
+        type: string
+        required: false # TODO Hand-rolled W-8253396
+      status:
+        description: The task's last execution status.
+        type: string
+        enum:
+          - Completed
+          - ExistingSetup
+          - Failed
+          - InProgress
+          - NotExecuted
+          - PreConditionNotMet
 
 /wave:
   /soql:
@@ -71,3 +192,29 @@ types:
         application/json:
           type: SoqlQueryInputRepresentation
           (oas-body-name): query
+  /templates/{templateIdOrApiName}/plans/{planName}:
+    get:
+      displayName: getWaveTemplateSetupPlan
+      description: Returns the plan.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateSetupPlanRepresentation
+    post:
+      displayName: postWaveTemplateSetupPlan
+      description: Execute a plan.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: TemplateSetupPlanRepresentation
+    uriParameters:
+      planName:
+        type: string
+        required: true
+      templateIdOrApiName:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -11,6 +11,11 @@ types:
   SoqlQueryResultRepresentation:
     (luvio.opaque): true
     (luvio.ttl): 5000
+  TemplateSetupPlanRepresentation:
+    (luvio.key):
+      templateId: templateId
+      planName: name
+    (luvio.ttl): 1000
 
 /wave:
   /soql:
@@ -18,3 +23,13 @@ types:
       (luvio.adapter):
         name: executeSoqlQueryPost
       (luvio.method): get
+  /templates/{templateIdOrApiName}/plans/{planName}:
+    get:
+      (luvio.adapter):
+        name: getTemplateSetupPlan
+      (luvio.key):
+        templateId: urlParams.templateIdOrApiName
+        planName: urlParams.planName
+    post:
+      (luvio.adapter):
+        name: executeTemplateSetupPlan