@salesforce/lds-adapters-industries-scheduler 1.100.2

package/src/raml/api.raml

@@ -0,0 +1,401 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '58.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.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:
+  AbstractServiceAppointmentInputRepresentation:
+    description: ' Service Appointment input representation'
+    type: object
+    properties:
+      assignedResources:
+        description: Assigned Resources
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: object
+      lead:
+        description: Lead
+        type: object
+        required: false #TODO: hand-rolled W-8253396
+      schedulingPolicyId:
+        description: Scheduling Policy Id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointment:
+        description: Service Appointment
+        type: object
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointmentId:
+        description: Service appointment Id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+  AssignedResourceInputRepresentation:
+    description: Input representation for Assigned Resource
+    type: object
+    properties:
+      extendedFields:
+        description: Extended fields
+        type: array
+        items:
+          type: object
+      isPrimaryResource:
+        description: Is primary resource
+        type: boolean
+      isRequiredResource:
+        description: Is required resource
+        type: boolean
+      serviceResourceId:
+        description: Service resource ID
+        type: string
+  AssignedResourceListInputRepresentation:
+    description: Input representation for a list of Assigned Resources
+    type: object
+    properties:
+      assignedResources:
+        description: List of Assigned Resources
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: object
+  CreateServiceAppointmentInputRepresentation:
+    description: Create Service Appointment input representation
+    type: object #TODO hand-rolled, extends abstract class and has no properties
+    properties:
+      assignedResources:
+        description: Assigned Resources
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: object
+      lead:
+        description: Lead
+        type: object
+        required: false #TODO: hand-rolled W-8253396
+      schedulingPolicyId:
+        description: Scheduling Policy Id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointment:
+        description: Service Appointment
+        type: object
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointmentId:
+        description: Service appointment Id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+  CreateServiceAppointmentData: #TODO: hand-rolled
+    description: A wrapper around CreateServiceAppointmentInputRepresentation
+    type: object
+    properties:
+      createServiceAppointmentInput:
+        description: The Oas Body name for create appointment data
+        type: CreateServiceAppointmentInputRepresentation
+  CreateServiceAppointmentResult:
+    description: Create residential loan application results representation
+    type: object
+    properties:
+      assignedResourceIds:
+        description: Assigned resource IDs
+        type: array
+        items:
+          type: string
+      parentRecordId:
+        description: Parent record ID
+        type: string
+      serviceAppointmentId:
+        description: Service appointment ID
+        type: string
+  ExtendedFieldInputRepresentation:
+    description: Input representation for extended fields
+    type: object
+    properties:
+      name:
+        description: Extended Field Name
+        type: string
+      value:
+        description: Extended Field Value
+        type: string
+  ExtendedFieldListInputRepresentation:
+    description: Wraps a list of extended fields.
+    type: object
+    properties:
+      extendedFields:
+        description: List of Extended Fields
+        type: array
+        items:
+          type: object
+  GetEngagementChannelTypeListResult:
+    description: Get engagement channel type list result
+    type: object
+    properties:
+      engagementChannelTypes:
+        description: List of Engagement Channel Types
+        type: array
+        items:
+          type: GetEngagementChannelTypeResult
+  GetEngagementChannelTypeOutputRepresentation:
+    description: Output representation of Get Engagement Channel Type (List) Representation
+    type: object
+    properties:
+      result:
+        description: Get Engagement Channel Type result
+        type: GetEngagementChannelTypeListResult
+  GetEngagementChannelTypeResult:
+    description: Get engagement channel type result
+    type: object
+    properties:
+      contactPoint:
+        description: Engagement Channel Type Contact Point
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      contactPointType:
+        description: Engagement Channel Type Contact Point Type
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      id:
+        description: Engagement Channel Type ID
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      name:
+        description: Engagement Channel Type name
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      workTypeGroupIds:
+        description: Engagement Channel Type Work Type Group Ids
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: string
+      workTypeIds:
+        description: Engagement Channel Type Work Type Ids
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: string
+  LeadInputRepresentation:
+    description: Input representation for Lead
+    type: object
+    properties:
+      company:
+        description: Company
+        type: string
+      email:
+        description: Email
+        type: string
+      extendedFields:
+        description: Extended fields
+        type: array
+        items:
+          type: object
+      firstName:
+        description: First name
+        type: string
+      lastName:
+        description: Last name
+        type: string
+      phone:
+        description: Phone
+        type: string
+  ServiceAppointmentInputRepresentation:
+    description: Input representation for Service Appointment
+    type: object
+    properties:
+      additionalInformation:
+        description: Additional information
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      appointmentType:
+        description: Appointment type
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      city:
+        description: City
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      comments:
+        description: Comments
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      contactId:
+        description: Contact ID
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      country:
+        description: Country
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      description:
+        description: Description
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      engagementChannelTypeId:
+        description: Engagement channel type id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      extendedFields:
+        description: Extended fields
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: object
+      parentRecordId:
+        description: Parent record ID
+        type: string
+      postalCode:
+        description: Postal code
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      schedEndTime:
+        description: Scheduled end time
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      schedStartTime:
+        description: Scheduled start time
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      serviceTerritoryId:
+        description: Service territory ID
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      state:
+        description: State
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      street:
+        description: Street
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      subject:
+        description: Subject
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      workTypeId:
+        description: Work type ID
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+  ServiceAppointmentOutputRepresentation:
+    description: Create service appointment output representation
+    type: object
+    properties:
+      result:
+        description: Result
+        type: ServiceAppointmentResult
+  ServiceAppointmentResult:
+    description: Create Service Appointment results representation
+    type: object
+    properties:
+      assignedResourceIds:
+        description: Assigned resource IDs
+        type: array
+        items:
+          type: string
+      parentRecordId:
+        description: Parent record ID
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointmentId:
+        description: Service appointment ID
+        type: string
+  UpdateServiceAppointmentInputRepresentation:
+    description: Update Service Appointment input representation
+    type: object #TODO hand-rolled - actually extends abstract class
+    properties:
+      assignedResources:
+        description: Assigned Resources
+        type: array
+        required: false #TODO: hand-rolled W-8253396
+        items:
+          type: object
+      lead:
+        description: Lead
+        type: object
+        required: false #TODO: hand-rolled W-8253396
+      schedulingPolicyId:
+        description: Scheduling Policy Id
+        type: string
+        required: false #TODO: hand-rolled W-8253396
+      serviceAppointment:
+        description: Service Appointment
+        type: object
+      serviceAppointmentId:
+        description: Service appointment Id
+        type: string
+  UpdateServiceAppointmentData: #TODO: hand rolled
+    description: A wrapper around the UpdateServiceAppointmentInputRepresentation
+    type: object
+    properties:
+      updateServiceAppointmentInput:
+        description: The Oas Boday Name for update service data
+        type: UpdateServiceAppointmentInputRepresentation
+
+/connect:
+  /scheduling:
+    /engagement-channel-types:
+      get:
+        description: 'Get list of engagement channel types  with specified work types or work type groups'
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GetEngagementChannelTypeOutputRepresentation
+        queryParameters:
+          workTypeGroupIds:
+            type: array
+            required: false #TODO: hand-rolled W-8253396
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          workTypeIds:
+            type: array
+            required: false #TODO: hand-rolled W-8253396
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /service-appointments:
+      patch:
+        description: Updating Service Appointment
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceAppointmentOutputRepresentation
+        body:
+          application/json:
+            type: UpdateServiceAppointmentData
+            (oas-body-name): updateServiceAppointmentInput
+      post:
+        description: Create a new Sample object. All fields are optional for this object.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ServiceAppointmentOutputRepresentation
+        body:
+          application/json:
+            type: CreateServiceAppointmentData
+            (oas-body-name): createServiceAppointmentInput

package/src/raml/luvio.raml

@@ -0,0 +1,30 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'IndustriesScheduler'
+(luvio.ttl): 360000
+
+types:
+  ServiceAppointmentOutputRepresentation:
+    (luvio.key):
+      id: result.serviceAppointmentId
+  ServiceAppointmentResult:
+    (luvio.key):
+      id: serviceAppointmentId
+
+/connect:
+  /scheduling:
+    /engagement-channel-types:
+      get:
+        (luvio.adapter):
+          name: getEngagementChannelTypes
+    /service-appointments:
+      patch:
+        (luvio.adapter):
+          name: updateServiceAppointment
+      post:
+        (luvio.adapter):
+          name: createServiceAppointment