@salesforce/lds-adapters-sales-yukon 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,247 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.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:
+  YukonNudgeInputRepresentation:
+    description: Yukon Nudge Input Representation
+    type: object
+    properties:
+      campaignId:
+        description: Nudge CampaignId
+        type: string
+      checksum:
+        description: Nudge Checksum
+        type: string
+      content:
+        description: Nudge Content
+        type: string
+      contentId:
+        description: Nudge ContentId
+        type: string
+      endDate:
+        description: Nudge End Date
+        type: string
+        required: false
+      hubId:
+        description: Nudge HubId
+        type: string
+      id:
+        description: Nudge Id
+        type: string
+      startDate:
+        description: Nudge Start Date
+        type: string
+      status:
+        description: Nudge Status
+        type: string
+      type:
+        description: Nudge Type
+        type: string
+      version:
+        description: Nudge Version
+        type: string
+      metadata:
+        description: Nudge Metadata
+        type: string
+  YukonNudgeOutputRepresentation:
+    description: A Yukon Nudge to display in a surface
+    type: object
+    properties:
+      id:
+        description: Id of the Nudge
+        type: string
+      payload:
+        description: Payload of the Nudge in the surface
+        type: object
+        properties:
+          //:
+            type: any # TODO: Handrolled W-7107899
+      startDate:
+        description: Start Date of the Nudge
+        required: false
+        type: string
+      endDate:
+        description: End Date of the Nudge
+        required: false
+        type: string
+      metadata:
+        description: All metadata associated with this nudge. Could be any combo of
+          schedules, app or page type metadata currently. Purposefully generic to
+          ensure later flexibility
+        required: false
+        type: object
+        properties:
+          //:
+            type: any # TODO: Handrolled W-7107899
+      actionState:
+        description: The state of how this nudge has been engaged with already
+        required: false
+        type: YukonNudgeActionStateRepresentation
+      contentType:
+        description: Type of the content in a nudge
+        required: false
+        type: string
+
+  YukonNudgeActionStateRepresentation:
+    description: A Yukon Nudge's state of how it's been engaged with
+    type: object
+    properties:
+      engagement:
+        description: Engagement counts for the primary and secondary CTAs
+        required: false
+        type: YukonNudgeActionEngagementRepresentation
+      lastSeen:
+        description: The time this nudge was last seen
+        required: false
+        type: string
+      seenCount:
+        description: How many times this nudge has been seen
+        required: false
+        type: integer
+      stepCount:
+        description: prompt specific. what step of a walkthrough we'd be on
+        required: false
+        type: integer
+
+  YukonNudgeActionEngagementRepresentation:
+    description: counts of how the CTA actions have been engaged with by a user
+    type: object
+    properties:
+      primary:
+        description: Primary CTA click count
+        required: false
+        type: integer
+      secondary:
+        description: Secondary CTA click count
+        required: false
+        type: integer
+
+  YukonSurfaceNudgesOutputRepresentation:
+    description: A collection of Yukon Nudges to display in a surface
+    type: object
+    properties:
+      errorMessage:
+        description: Error message
+        required: false
+        type: string
+      nudges:
+        description: List of Nudges
+        type: array
+        items:
+          type: YukonNudgeOutputRepresentation
+      status:
+        description: Status
+        type: string
+      surface:
+        description: The surface nudges are for
+        type: string
+
+  YukonTelemetryInputGroupRepresentation:
+    description: Yukon Telemetry Input Representation
+    type: object
+    properties:
+      actions:
+        description: Telemetry Actions
+        type: array
+        items:
+          type: YukonTelemetryInputRepresentation
+  YukonTelemetryInputRepresentation:
+    description: Yukon Telemetry Input Representation
+    type: object
+    properties:
+      nudgeUniqueName:
+        description: Nudge Unique Name
+        type: string
+      timestamp:
+        description: Action Timestamp
+        # TODO: Hand-rolled from "format: int64, type: integer" due to W-8274943
+        format: double
+        type: number
+      actionType:
+        description: Action Type
+        type: string
+  YukonTelemetryOutputRepresentation:
+    description: The result of posting telemetry data to CAS
+    type: object
+    properties:
+      errorMessage:
+        description: Error message
+        required: false
+        type: string
+      status:
+        description: Status
+        type: string
+/yukon:
+  /surfaces/{surfaceId}/nudges:
+    get:
+      displayName: getYukonSurfaceNudges
+      description: Get Yukon Nudges for surface
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: YukonSurfaceNudgesOutputRepresentation
+    uriParameters:
+      surfaceId:
+        type: string
+        required: true
+  /surfaces/{surfaceId}/nudges/mock:
+    get:
+      displayName: getYukonSurfaceNudgesMock
+      description: Get Yukon mock Nudges for surface
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: YukonSurfaceNudgesOutputRepresentation
+      queryParameters:
+        mockWith:
+          type: string
+          required: false
+        size:
+          type: integer
+          required: false
+    uriParameters:
+      surfaceId:
+        type: string
+        required: true
+  /telemetry:
+    post:
+      displayName: postYukonTelemetry
+      description: Post Telemetry to CAS
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: YukonTelemetryOutputRepresentation
+      body:
+        application/json:
+          type: YukonTelemetryInputGroupRepresentation
+          # TODO hand-rolled W-9271732 (removed required: false)
+          (oas-body-name): YukonTelemetryActions

package/src/raml/luvio.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'Yukon'
+(luvio.ttl): 30000
+
+types:
+  YukonTelemetryOutputRepresentation:
+    (luvio.key):
+      id: status
+  YukonSurfaceNudgesOutputRepresentation:
+    (luvio.key):
+      surface: surface
+/yukon:
+  /surfaces/{surfaceId}/nudges:
+    get:
+      (luvio.adapter):
+        name: getYukonSurfaceNudges
+      (luvio.key):
+        surface: urlParams.surfaceId
+  /surfaces/{surfaceId}/nudges/mock:
+    get:
+      (luvio.adapter):
+        name: getYukonSurfaceNudgesMock
+      (luvio.key):
+        surface: urlParams.surfaceId
+  /telemetry:
+    post:
+      (luvio.adapter):
+        name: postYukonTelemetry