@salesforce/lds-adapters-sales-user-working-hours 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,464 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.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:
+  EngagementAggregationRequest:
+    description: Input representation for Get engagement aggregation data for days
+    type: object
+    properties:
+      cadenceStepId:
+        description: CadenceStepId
+        type: string
+      channelActions:
+        description: ChannelActions
+        type: array
+        items:
+          type: string
+      channelTypes:
+        description: ChannelTypes
+        type: array
+        items:
+          type: string
+      metricsEntityIds:
+        description: MetricsEntityIds - TargetIds (Contact/Lead/PA)
+        type: array
+        items:
+          type: string
+      numberOfDaysInPast:
+        description: NumberOfDaysInPast
+        type: integer
+      numberOfMonthsInPast:
+        description: numberOfMonthsInPast
+        type: integer
+  EngagementEventResponse:
+    description: Represents the EngagementEvent logging response
+    type: object
+    properties:
+      errorMsg:
+        description: Represents the API error msg in case of any
+        type: string
+      isSuccess:
+        description: Represents if the API call was successful or not
+        type: boolean
+  HVSMetricOutputRepresentation:
+    description: Represents the Engagement Metrics response
+    type: object
+    properties:
+      channelAction:
+        description: Represents the channel action
+        type: string
+      channelType:
+        description: Represents the channel type
+        type: string
+      channelVehicleId:
+        description: Represents the channel vehicle id
+        type: string
+      total:
+        description: Represents the total for channelType and channelAction for given
+          channelVehicleId
+        type: integer
+  HVSMetricsRequest:
+    description: Input representation for making a call to get Engagement Metrics
+    type: object
+    properties:
+      channelActions:
+        description: ChannelActions
+        type: array
+        items:
+          type: string
+      channelTypes:
+        description: ChannelTypes
+        type: array
+        items:
+          type: string
+      channelVehicleIds:
+        description: ChannelVehicleIds
+        type: array
+        items:
+          type: string
+  HVSMetricsResponse:
+    description: Represents the Engagement Metrics response
+    type: object
+    properties:
+      errorMsg:
+        description: Represents the API error msg in case of any
+        type: string
+      isSuccess:
+        description: Represents if the API call was successful or not
+        type: boolean
+      metrics:
+        description: Represents the metrics
+        type: array
+        items:
+          type: HVSMetricOutputRepresentation
+  HighVelocityEngagementEventRequest:
+    description: Input representation for making a call to log EngagementEvent
+    type: object
+    properties:
+      engagements:
+        description: Engagements
+        type: array
+        items:
+          type: object
+  HighVelocityEngagementRequest:
+    description: Input representation for making a call to log EngagementEvent
+    type: object
+    properties:
+      assetTrackingTypes:
+        description: assetTrackingTypes
+        type: string
+      bounceReason:
+        description: bounceReason
+        type: string
+      channelAction:
+        description: Channel Action
+        type: string
+      channelType:
+        description: Channel Type
+        type: string
+      channelVehicleId:
+        description: Channel Vehicle ID
+        type: string
+      channelVehicleParentId:
+        description: Channel Vehicle Parent ID
+        type: string
+      device:
+        description: Device
+        type: string
+      emailAddress:
+        description: emailAddress
+        type: string
+      engagementDate:
+        description: Engagement Date
+        type: string
+      linkUrl:
+        description: Link Url
+        type: string
+      targetId:
+        description: Target ID
+        type: string
+      targetTrackingTypes:
+        description: targetTrackingTypes
+        type: string
+      templateId:
+        description: Template ID
+        type: string
+      userAgent:
+        description: User Agent
+        type: string
+      userId:
+        description: User ID
+        type: string
+      workflowStepId:
+        description: Workflow Step ID
+        type: string
+      workflowStepTracker:
+        description: WorkflowStepTracker
+        type: string
+  SalesAlertsRequest:
+    description: Input representation for posting a call to pull data from SIQ Store
+    type: object
+    properties:
+      relatedRecordIds:
+        description: RelatedRecordIds
+        type: array
+        items:
+          type: string
+      unifiedEmailIds:
+        description: UnifiedEmailIds
+        type: array
+        items:
+          type: string
+  SalesAlertsResponse:
+    description: Represents the SalesAlertsResponse from SIQ Store
+    type: object
+    properties:
+      errorMsg:
+        description: Represents the API error msg in case of any
+        type: string
+      isSuccess:
+        description: Represents if the API call was successful or not
+        type: boolean
+      metricsByRelatedRecordId:
+        description: 'Represents metrics information from related recode id '
+        type: object
+        properties:
+          //:
+            type: object
+            properties:
+              //:
+                type: integer
+      recordDataByUnifiedEmailId:
+        description: 'Represents metrics information from email addresses based on
+          unified Email Id '
+        type: object
+        properties:
+          //:
+            type: object
+            properties:
+              //:
+                type: object
+    # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+  SalesUserWorkingHoursRequestWrapper:
+    description: Wrapper for SalesUserWorkingHoursRequest
+    type: object
+    properties:
+      salesUserWorkingHoursRequest:
+        type: SalesUserWorkingHoursRequest
+        description: Sales User Working Hours Request Input Representation
+  SalesUserWorkingHoursRequest:
+    description: Input representation for sales user working hours
+    type: object
+    properties:
+      salesUserWorkingHoursType:
+        description: SalesUserWorkingHoursType
+        type: string
+      timeSlots:
+        description: TimeSlots
+        type: array
+        items:
+          type: TimeSlotInputRepresentation
+  TimeSlotInputRepresentation: # TODO Handrolled Missing Types from RAML - W-7093257
+    description: Represents the Sales User Working Hours request
+    type: object
+    properties:
+      dayOfWeek:
+        description: Represents the day of the week
+        type: string
+        required: false # TODO Handrolled W-9314597
+      endTime:
+        description: Represents the End time in HH:MM format. Example - 5:00 PM end
+          time gets represented as 17:00
+        type: string
+        required: false # TODO Handrolled W-9314597
+      startTime:
+        description: Represents the start time in HH:MM format. Example - 9:30 AM
+          start time gets represented as 09:30
+        type: string
+        required: false # TODO Handrolled W-9314597
+      id:
+        description: Represents the time slot unique identifier. It's a SFDC record
+          id of TimeSlot entity
+        type: string
+        required: false # TODO Handrolled W-9314597
+  SalesUserWorkingHoursGetResponseWrapper: # Handrolled to avoid get response update from post and patch calls due to same response type
+    description: Wrapper for SalesUserWorkingHoursResponse
+    type: object
+    properties:
+      timeSlots:
+        description: Represents the timeslots
+        type: array
+        items:
+          type: TimeSlotOutputRepresentation
+      timeZone:
+        description: Represents the timezone
+        type: string | nil # Handrolled to allow null timezone.
+      userId:
+        description: Represents the related userId
+        type: string
+  SalesUserWorkingHoursResponse:
+    description: Represents the Sales User Working Hours response
+    type: object
+    properties:
+      timeSlots:
+        description: Represents the timeslots
+        type: array
+        items:
+          type: TimeSlotOutputRepresentation
+      timeZone:
+        description: Represents the timezone
+        type: string | nil # Handrolled to allow null timezone.
+      userId:
+        description: Represents the related userId
+        type: string
+  TimeSlotOutputRepresentation:
+    description: Represents the Sales User Working Hours response
+    type: object
+    properties:
+      dayOfWeek:
+        description: Represents the day of the week
+        type: string
+      endTime:
+        description: Represents the End time in HH:MM format. Example - 5:00 PM end
+          time gets represented as 17:00
+        type: string
+      id:
+        description: Represents the time slot unique identifier. It's a SFDC record
+          id of TimeSlot entity
+        type: string
+      startTime:
+        description: Represents the start time in HH:MM format. Example - 9:30 AM
+          start time gets represented as 09:30
+        type: string
+  UpdateAlertsRequest:
+    description: Input representation for updating alert status
+    type: object
+    properties:
+      alertId:
+        description: alertId
+        type: string
+      alertRuleId:
+        description: alertStatus
+        type: string
+      alertStatus:
+        description: alertStatus
+        type: string
+/activity-engagement:
+  /events/engagement:
+    put:
+      description: Resource to log engagement event
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EngagementEventResponse
+      body:
+        application/json:
+          type: HighVelocityEngagementEventRequest
+          (oas-body-name): activityEngagementRequest
+  /metrics/engagement:
+    # TODO: Hand rolled
+    # post:
+    #   description: Resource to get engagement metrics
+    #   responses:
+    #     '200':
+    #       description: Success
+    #       body:
+    #         application/json:
+    #           type: HVSMetricsResponse
+    #   body:
+    #     application/json:
+    #       type: HVSMetricsRequest
+    #       (oas-body-name): engagementMetricsRequest
+/sales-alerts/data-and-metrics:
+  # TODO: Hand rolled
+  # post:
+  #   description: Resource to get sales alerts data and metrics
+  #   responses:
+  #     '200':
+  #       description: Success
+  #       body:
+  #         application/json:
+  #           type: SalesAlertsResponse
+  #   body:
+  #     application/json:
+  #       type: SalesAlertsRequest
+  #       (oas-body-name): salesAlertsRequest
+/sales/working-hours/time-slots:
+  delete:
+    description: Resource to delete a timeslot
+    responses:
+      '200':
+        description: Success
+  get:
+    description: Resource to get timeslots
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SalesUserWorkingHoursGetResponseWrapper # Handrolled to avoid get response update from post and patch calls due to same response type
+    queryParameters:
+      userId:
+        type: string
+        required: true # Handrolled to have same key on the get luvio key with response luvio key
+      workingHoursType:
+        type: string
+        required: false
+  patch:
+    description: Resource to update a timeslot
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SalesUserWorkingHoursResponse
+    body:
+      application/json:
+        type: SalesUserWorkingHoursRequestWrapper # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+        (oas-body-name): salesUserWorkingHoursRequest
+  post:
+    description: Resource to create timeslots
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SalesUserWorkingHoursResponse
+    body:
+      application/json:
+        type: SalesUserWorkingHoursRequestWrapper # TODO Hand-Rolled due to issue #28 in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAMmFgP)
+        (oas-body-name): salesUserWorkingHoursRequest
+/sales/working-hours/time-slots/{id}:
+  delete:
+    description: Resource to delete a timeslot
+    responses:
+      '200':
+        description: Success
+  get:
+    description: Resource to get timeslots
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: TimeSlotOutputRepresentation #Handrolled
+    queryParameters:
+      userId:
+        type: string
+        required: false
+      workingHoursType:
+        type: string
+        required: false
+  patch:
+    description: Resource to update a timeslot
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SalesUserWorkingHoursResponse
+    body:
+      application/json:
+        type: SalesUserWorkingHoursRequest
+        (oas-body-name): salesUserWorkingHoursRequest
+  post:
+    description: Resource to create timeslots
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: SalesUserWorkingHoursResponse
+    body:
+      application/json:
+        type: SalesUserWorkingHoursRequest
+        (oas-body-name): salesUserWorkingHoursRequest
+  uriParameters:
+    id:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,43 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'user-working-hours'
+(luvio.ttl): 100
+
+types:
+  SalesUserWorkingHoursGetResponseWrapper:
+    (luvio.key):
+      salesUserId: userId
+    (luvio.updateAvailable):
+      name: notifyUserWorkingHoursUpdateAvailable
+      parameters:
+        salesUserId: userId
+  SalesUserWorkingHoursResponse:
+    (luvio.key):
+      salesUserId: userId
+  TimeSlotOutputRepresentation:
+    (luvio.key):
+      timeSlotId: id
+
+/sales/working-hours/time-slots:
+  get:
+    (luvio.adapter):
+      name: getSalesUserWorkingHours
+    (luvio.key):
+      salesUserId: queryParams.userId
+  patch:
+    (luvio.adapter):
+      name: updateSalesUserWorkingHours
+  post:
+    (luvio.adapter):
+      name: createSalesUserWorkingHours
+
+/sales/working-hours/time-slots/{id}:
+  delete:
+    (luvio.adapter):
+      name: deleteSalesUserWorkingHours
+    (luvio.key):
+      timeSlotId: urlParams.id