@salesforce/lds-adapters-service-salesforcejourney 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,554 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '64.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:
+  CapabilitiesCollectionOutputRepresentation:
+    description: Represents a collection of capabilities
+    type: object
+    properties:
+      capabilities:
+        description: The capabilities
+        type: array
+        items:
+          type: CapabilityOutputRepresentation
+  CapabilityContactUsInputRepresentation:
+    description: Represents contactus input
+    type: object
+    properties:
+      capabilityId:
+        description: The Capability Id
+        type: string
+      notes:
+        description: The user notes for contactUs
+        type: string
+      reason:
+        description: The reason for contactUs
+        type: string
+  CapabilityContactUsOutputRepresentation:
+    description: output representation for contactUs
+    type: object
+    properties:
+      isSuccess:
+        description: ContactUs Result
+        type: boolean
+  CapabilityContentOutputRepresentation:
+    description: Represents a capability content
+    type: object
+    properties:
+      addonRequired:
+        description: Indicates whether need a Salesforce add-on for the capability
+          that user should contact Salesforce for the capability
+        type: boolean | nil
+      businessGoals:
+        description: The business goals associated with the capability
+        type: array
+        items:
+          type: TermOutputRepresentation
+      complete:
+        description: Indicates whether the capability content is complete
+        type: boolean
+      description:
+        description: The capability description
+        type: string
+      implBestPractices:
+        description: The implementation best practices associated with the capability
+        type: string | nil
+      measures:
+        description: The measures associated with the capability
+        type: string | nil
+      minimumEdition:
+        description: The minimum edition required for the capability
+        type: TermOutputRepresentation | nil
+      productAndLicensing:
+        description: The product and licensing information associated with the capability
+        type: string | nil
+      release:
+        description: The release associated with the capability
+        type: string | nil
+      resources:
+        description: The resources associated with the capability
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any #it changed from type: string otherwise the assertion for expected resources fails
+      salesforceCloud:
+        description: The Salesforce cloud associated with the capability
+        type: string | nil
+      salesforceGoLinks:
+        description: The salesforce Go links associated with the capability
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any #hand roll. Match the type with the resources field.
+      tags:
+        description: The tags associated with the capability
+        type: array
+        items:
+          type: TermOutputRepresentation
+      title:
+        description: The capability title
+        type: string
+      usageBestPractices:
+        description: The usage best practices associated with the capability
+        type: string | nil
+      videoLink:
+        description: The embedded video url associated with the capability
+        type: string | nil
+  CapabilityOutputRepresentation:
+    description: Represents a capability info
+    type: object
+    properties:
+      businessGoals:
+        description: The categories business goals
+        type: array
+        items:
+          type: TermOutputRepresentation
+      categoryParents:
+        description: The capability parents
+        type: array
+        items:
+          type: CategoryTreeNodeOutputRepresentation
+      contentDurableId:
+        description: The capability id
+        type: string
+      description:
+        description: The capability description
+        type: string
+      myCapability:
+        description: The user data for the capability
+        type: MyCapabilityOutputRepresentation | nil
+      name:
+        description: The capability name
+        type: string
+      tags:
+        description: The categories tags
+        type: array
+        items:
+          type: TermOutputRepresentation
+  CapabilitySearchInputRepresentation:
+    description: Represents a search input
+    type: object
+    properties:
+      searchTerm:
+        description: Search Terms
+        type: string
+  CapabilitySearchResultOutputRepresentation:
+    description: Represents a search result (The capabilities IDs that match the search)
+    type: object
+    properties:
+      contentDurableIds:
+        description: The ID's that match the search
+        type: array
+        items:
+          type: string
+  CapabilityUserPreferenceInputRepresentation:
+    description: Represents capability user preference
+    type: object
+    properties:
+      contentDurableId:
+        description: The capability id
+        type: string
+      id:
+        description: The user data id of a capability info
+        type: string
+        required: false
+      lastContactRequestDate:
+        description: The last contact request data time in UTC
+        type: string
+        required: false
+      stage:
+        description: The stage state for capability info user data
+        type: string
+        required: false
+      starred:
+        description: The starred state for capability info user data
+        type: boolean
+        required: false
+      status:
+        description: The status state for capability info user data
+        type: string
+        required: false
+  CategoriesMetadataOutputRepresentation:
+    description: Represents the categories metadata
+    type: object
+    properties:
+      businessGoals:
+        description: The categories business goals
+        type: array
+        items:
+          type: TermOutputRepresentation
+      categories:
+        description: The categories structure
+        type: array
+        items:
+          type: CategoryTreeNodeOutputRepresentation
+      editions:
+        description: The categories editions
+        type: array
+        items:
+          type: TermOutputRepresentation
+      stages:
+        description: The available stages for a capability
+        type: array
+        items:
+          type: TermOutputRepresentation
+      statuses:
+        description: The available statuses for a capability
+        type: array
+        items:
+          type: TermOutputRepresentation
+      tags:
+        description: The categories tags
+        type: array
+        items:
+          type: TermOutputRepresentation
+  CategoryTreeNodeOutputRepresentation:
+    description: Represents single category
+    type: object
+    properties:
+      children:
+        description: Category's children
+        type: array
+        items:
+          type: any # the recursive structure is not yet supported
+          # type: CategoryTreeNodeOutputRepresentation
+      parents:
+        description: Category's parents
+        type: array
+        items:
+          type: any # the recursive structure is not yet supported
+          # type: CategoryTreeNodeOutputRepresentation
+      term:
+        description: The category term
+        type: TermOutputRepresentation
+  FilterConditionCollectionInputRepresentation:
+    description: Represents a collections of filter conditions
+    type: object
+    properties:
+      filterConditions:
+        description: The filter conditions
+        type: array
+        items:
+          type: FilterConditionInputRepresentation # it changed from type: object
+  FilterConditionInputRepresentation:
+    description: Represents a filter conditions
+    type: object
+    properties:
+      filterType:
+        description: The filter condition type
+        type: string
+      values:
+        description: The filter condition values
+        type: array
+        items:
+          type: string
+  InitiativeOutputRepresentation:
+    description: Represents an initiative info
+    type: object
+    properties:
+      businessGoals:
+        description: The initiative business goals
+        type: array
+        items:
+          type: TermOutputRepresentation
+      category:
+        description: The categories structure
+        type: TermOutputRepresentation
+      contentDurableId:
+        description: The initiative id
+        type: string
+      description:
+        description: The initiative description
+        type: string
+      myInitiative:
+        description: The user data for the initiative
+        type: MyInitiativeOutputRepresentation | nil
+      name:
+        description: The initiative name
+        type: string
+      relatedCapabilities:
+        description: The initiative related capabilities
+        type: array
+        items:
+          type: string
+      stage:
+        description: The initiative stage
+        type: TermOutputRepresentation
+      tags:
+        description: The initiative tags
+        type: array
+        items:
+          type: TermOutputRepresentation
+  InitiativeUserPreferenceInputRepresentation:
+    description: Represents user initiative preference
+    type: object
+    properties:
+      contentDurableId:
+        description: The initiative id
+        type: string
+      id:
+        description: The user data id of a initiative info
+        type: string
+        required: false
+      stage:
+        description: The stage state for initiative info user data
+        type: string
+        required: false
+      status:
+        description: The status state for initiative info user data
+        type: string
+        required: false
+  InitiativesCollectionOutputRepresentation:
+    description: Represents a collection of Initiatives
+    type: object
+    properties:
+      initiatives:
+        description: The initiatives
+        type: array
+        items:
+          type: InitiativeOutputRepresentation
+  JourneyMapMetadataOutputRepresentation:
+    description: Represents the journey map metadata
+    type: object
+    properties:
+      businessGoals:
+        description: The Journey Map business goals
+        type: array
+        items:
+          type: TermOutputRepresentation
+      categories:
+        description: The categories structure
+        type: array
+        items:
+          type: TermOutputRepresentation
+      stages:
+        description: The available stages for an initiative
+        type: array
+        items:
+          type: TermOutputRepresentation
+      statuses:
+        description: The available statuses for an initiatives
+        type: array
+        items:
+          type: TermOutputRepresentation
+  MyCapabilityOutputRepresentation:
+    description: Represents a capability user data info
+    type: object
+    properties:
+      contentDurableId:
+        description: The capability id
+        type: string
+      id:
+        description: The user data id of a capability info
+        type: string
+      lastContactRequestDate:
+        description: The last contact request data time in UTC
+        type: string | nil
+      stage:
+        description: The stage state for capability info user data
+        type: string
+      starred:
+        description: The starred state for capability info user data
+        type: boolean
+      status:
+        description: The status state for capability info user data
+        type: string
+  MyInitiativeOutputRepresentation:
+    description: Represents an initiative user data info
+    type: object
+    properties:
+      contentDurableId:
+        description: The initiative id
+        type: string
+      id:
+        description: The user data id of a initiative info
+        type: string
+      stage:
+        description: The stage state for initiative info user data
+        type: string
+      status:
+        description: The status state for initiative info user data
+        type: string
+  TermOutputRepresentation:
+    description: Category term such as business goals or tags
+    type: object
+    properties:
+      label:
+        description: Term label
+        type: string | nil
+      value:
+        description: Term value
+        type: string
+/connect/salesforce-journey:
+  /capability-content/{capabilityContentId}:
+    get:
+      displayName: getCapabilityContent
+      description: Returns the capability content
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CapabilityContentOutputRepresentation
+    uriParameters:
+      capabilityContentId:
+        type: string
+        required: true
+  /capability-user-preference:
+    post:
+      displayName: postCapabilityUserPreference
+      description: upsert capability user preference
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MyCapabilityOutputRepresentation
+      body:
+        application/json:
+          type: CapabilityUserPreferenceInputRepresentation
+          #required: false # TODO hand rolled. W-9275477
+          (oas-body-name): capabilityUserPreferenceInput
+  /contact-us:
+    post:
+      displayName: postCapabilityContactUs
+      description: create contact us lead request
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CapabilityContactUsOutputRepresentation
+      body:
+        application/json:
+          type: CapabilityContactUsInputRepresentation
+          #required: false # TODO hand rolled. W-9275477
+          (oas-body-name): capabilityContactUsInput
+  /journey-map/initiatives/user-preference:
+    post:
+      displayName: postInitiativeUserPreference
+      description: upsert initiative user preference
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: MyInitiativeOutputRepresentation
+      body:
+        application/json:
+          type: InitiativeUserPreferenceInputRepresentation
+          #required: false # TODO hand rolled. W-9275477
+          (oas-body-name): initiativeUserPreferenceInput
+  /{cloudOwnership}:
+    /capabilities:
+      post:
+        displayName: postCapabilities
+        description: Returns capabilities by filters
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CapabilitiesCollectionOutputRepresentation
+        body:
+          application/json:
+            type: FilterConditionCollectionInputRepresentation
+            #required: false # TODO hand rolled. W-9275477
+            (oas-body-name): filterConditionsInput
+      uriParameters:
+        cloudOwnership:
+          type: string
+          required: true
+    /capability-search:
+      get:
+        displayName: getCapabilitySearch
+        description: Returns the Ids that matches the search term
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CapabilitySearchResultOutputRepresentation
+        queryParameters:
+          searchTerm:
+            type: string
+            required: false
+      uriParameters:
+        cloudOwnership:
+          type: string
+          required: true
+    /categories:
+      get:
+        displayName: getCategories
+        description: Returns the categories metadata
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CategoriesMetadataOutputRepresentation
+      uriParameters:
+        cloudOwnership:
+          type: string
+          required: true
+    /journey-map:
+      /initiatives:
+        post:
+          displayName: postInitiatives
+          description: Returns initiatives by filters
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: InitiativesCollectionOutputRepresentation
+          body:
+            application/json:
+              type: FilterConditionCollectionInputRepresentation
+              #required: false # TODO hand rolled. W-9275477
+              (oas-body-name): filterConditionsInput
+        uriParameters:
+          cloudOwnership:
+            type: string
+            required: true
+      /metadata:
+        get:
+          displayName: getJourneyMapMetadata
+          description: Returns the Journey Map metadata
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: JourneyMapMetadataOutputRepresentation
+        uriParameters:
+          cloudOwnership:
+            type: string
+            required: true

package/src/raml/luvio.raml

@@ -0,0 +1,61 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'salesforceJourney'
+(luvio.ttl): 200
+
+types:
+  MyCapabilityOutputRepresentation:
+    (luvio.key):
+      id: id
+  CapabilityContactUsOutputRepresentation:
+    (luvio.key):
+      isSuccess: isSuccess
+    (luvio.ttl): 100 # Almost no-cache
+  MyInitiativeOutputRepresentation:
+    (luvio.key):
+      id: id
+
+/connect/salesforce-journey:
+  /capability-content/{capabilityContentId}:
+    get:
+      (luvio.adapter):
+        name: getCapabilityContentDocument
+  /capability-user-preference:
+    post:
+      (luvio.adapter):
+        name: upsertCapabilityUserPreference
+  /journey-map/initiatives/user-preference:
+    post:
+      (luvio.adapter):
+        name: upsertInitiativeUserPreference
+  /{cloudOwnership}:
+    /capabilities:
+      post:
+        (luvio.adapter):
+          name: getCapabilities
+        (luvio.method): get # the  API is not creating, updating, or deleting data
+    /capability-search:
+      get:
+        (luvio.adapter):
+          name: getCapabilitySearchResult
+    /categories:
+      get:
+        (luvio.adapter):
+          name: getCategoriesMetadata
+    /journey-map/metadata:
+      get:
+        (luvio.adapter):
+          name: getJourneyMapMetadata
+    /journey-map/initiatives:
+      post:
+        (luvio.adapter):
+          name: getInitiatives
+        (luvio.method): get # the  API is not creating, updating, or deleting data
+  /contact-us:
+    post:
+      (luvio.adapter):
+        name: createContactUsLeadRequest