@salesforce/lds-adapters-sales-pathassistant 1.245.0

package/src/raml/api.raml

@@ -0,0 +1,210 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v60.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:
+  PathAssistantFieldRepresentation:
+    description: Path Assistant Field returned by Connect API
+    type: object
+    properties:
+      apiName:
+        description: Value representing Path Assistant Field API name
+        type: string
+      label:
+        description: Value representing Path Assistant Field label
+        type: string
+      isReadonly:
+        description: Value representing Path Assistant Field isReadonly
+        type: boolean
+      isRequired:
+        description: Value representing Path Assistant Field isRequired
+        type: boolean
+  PathAssistantStepRepresentation:
+    description: Path Assistant Step returned by Connect API
+    type: object
+    properties:
+      picklistLabel:
+        description: Value representing Path Assistant Step picklist label
+        type: string
+      picklistValue:
+        description: Value representing Path Assistant Step picklist value
+        type: string
+      isClosed:
+        description: Value representing Path Assistant Step picklist isClosed
+        type: boolean
+      isWon:
+        description: Value representing Path Assistant Step picklist isWon
+        type: boolean
+      isConverted:
+        description: Value representing Path Assistant Step picklist isConverted
+        type: boolean
+      fields:
+        description: Value representing Path Assistant Step fields
+        type: array
+        items:
+          type: PathAssistantFieldRepresentation
+      guidance:
+        description: Value representing Path Assistant Step guidance
+        type: string | nil
+  PicklistEntryRepresentation:
+    description: Picklist Entry returned by Connect API
+    type: object
+    properties:
+      label:
+        description: Value representing picklist label
+        type: string
+      value:
+        description: Value representing picklist value
+        type: string
+      isDefault:
+        description: Value representing picklist isDefault
+        type: boolean
+      validFor:
+        description: Value representing picklist valid for
+        type: string | nil ### TODO
+      isActive:
+        description: Value representing picklist isActive
+        type: boolean
+  PicklistForRecordTypeRepresentation:
+    description: Picklist for Record Type returned by Connect API
+    type: object
+    properties:
+      picklistName:
+        description: Value representing picklist name
+        type: string
+      picklists:
+        description: Value representing picklists
+        type: array
+        items:
+          type: PicklistEntryRepresentation
+  AnimationRuleRepresentation:
+    description: Animation Rule returned by Connect API
+    type: object
+    properties:
+      targetField:
+        description: Value representing Animation Rule target field
+        type: string
+      targetFieldChangeToValues:
+        description: Value representing Animation Rule target field change to values
+        type: string ### TODO
+      recordTypeContext:
+        description: Value representing Animation Rule Record Type context
+        type: string | nil ### TODO
+      recordTypeId:
+        description: Value representing Animation Rule Record Type Id
+        type: string | nil
+      animationFrequency:
+        description: Value representing Animation Rule animation frequency
+        type: string | nil
+      isActive:
+        description: Value representing Animation Rule isActive
+        type: boolean
+  PathAssistantRepresentation:
+    description: Path Assistant returned by Connect API
+    type: object
+    properties:
+      apiName:
+        description: Value representing Path Assistant API name
+        type: string
+      label:
+        description: Value representing Path Assistant label
+        type: string
+      picklistField:
+        description: Value representing Path Assistant picklist field
+        type: string
+      recordTypeId:
+        description: Value representing Path Assistant Record Type Id
+        type: string | nil
+      steps:
+        description: Value representing Path Assistant steps
+        type: array
+        items:
+          type: PathAssistantStepRepresentation
+      picklistsForRecordType:
+        description: Value representing Path Assistant picklists for Record Type
+        type: array
+        items:
+          type: PicklistForRecordTypeRepresentation
+      animationRule:
+        description: Value representing Path Assistant animation rule
+        type: array
+        items:
+          type: AnimationRuleRepresentation
+      isActive:
+        description: Value representing Path Assistant isActive
+        type: boolean
+  PathAssistantMetadataRepresentation:
+    description: Path Assistant metadata returned by Connect API
+    type: object
+    properties:
+      pathAssistants:
+        description: Value representing Path Assistants
+        type: array
+        items:
+          type: PathAssistantRepresentation
+
+  PathAssistantDaysInStageRepresentation:
+    description: Path Assistant days-in-stage data returned by Connect API
+    type: object
+    properties:
+      picklistValuesToDays:
+        description: Value representing Path Assistant days-in-stage data
+        type: any
+
+/connect/pathassistant:
+  /{recordId}:
+    get:
+      displayName: getPathAssistant
+      description: Query Path Assistant metadata
+      queryParameters:
+        picklistFieldApiName:
+          type: string
+          required: false
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PathAssistantMetadataRepresentation
+    uriParameters:
+      recordId:
+        type: string
+        required: true
+  /{recordId}/daysInStage:
+    get:
+      displayName: getPathAssistantDaysInStage
+      description: Query Path Assistant days-in-stage data
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PathAssistantDaysInStageRepresentation
+    uriParameters:
+      recordId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'pathassistant'
+
+types:
+  PathAssistantDaysInStageRepresentation:
+    (luvio.ttl): 30000
+  PathAssistantMetadataRepresentation:
+    (luvio.ttl): 30000
+
+/connect/pathassistant:
+  /{recordId}:
+    get:
+      (luvio.adapter):
+        name: getPathAssistant
+  /{recordId}/daysInStage:
+    get:
+      (luvio.adapter):
+        name: getPathAssistantDaysInStage