@salesforce/lds-adapters-industries-scheduler 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,933 @@
+#%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
+  GetNextWaitlistParticipantOutputRepresentation:
+    description: Output representation of Get Next Waitlist Participant Representation
+    type: object
+    properties:
+      result:
+        description: Get Next Waitlist Participant result
+        type: GetNextWaitlistParticipantResult
+  GetNextWaitlistParticipantResult:
+    description: Get next waitlist participant result
+    type: object
+    properties:
+      waitlistParticipantId:
+        description: Waitlist Participant ID
+        required: false
+        type: string
+      waitlistServiceResource:
+        description: Waitlist Service Resource
+        type: WaitlistServiceResourceWithWorkTypes
+      workTypeGroups:
+        description: Work Type Groups
+        required: false
+        type: array
+        items:
+          type: WaitlistWorkTypeGroup
+      workTypeId:
+        description: Work Type ID
+        required: false
+        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
+  ParticipantRecentInteractionsOutputRepresentation:
+    description: Output representation of Participant Recent Interactions
+    type: object
+    properties:
+      result:
+        description: Participant Recent Interactions result
+        type: ParticipantRecentInteractionsResult
+  ParticipantRecentInteractionsResult:
+    description: Participant Recent Interactions
+    type: object
+    properties:
+      serviceResources:
+        description: Service Resources
+        type: array
+        items:
+          type: WaitlistServiceResource
+  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
+  WaitlistAnalytics:
+    description: Waitlist Analytics
+    type: object
+    properties:
+      currentParticipant:
+        description: Current participants
+        required: false
+        type: integer
+      servedParticipant:
+        description: Served participants
+        required: false
+        type: integer
+      totalParticipant:
+        description: Total participants
+        required: false
+        type: integer
+      totalWaitingTimeInMin:
+        description: Total waiting time in minutes
+        required: false
+        type: integer
+  WaitlistAppointmentInputRepresentation:
+    description: Waitlist Appointment Input Representation
+    type: object
+    properties:
+      userId:
+        description: User Id
+        type: string
+      waitlistParticipantId:
+        description: Waitlist Participant Id
+        type: string
+  WaitlistAppointmentData: #TODO: hand-rolled
+    description: A wrapper around WaitlistAppointmentInputRepresentation
+    type: object
+    properties:
+      waitlistAppointmentInput:
+        description: The Oas Body name for waitlist appointment data
+        type: WaitlistAppointmentInputRepresentation
+  WaitlistAppointmentOutputRepresentation:
+    description: Waitlist Appointment output representation
+    type: object
+    properties:
+      result:
+        description: Waitlist Appointment result
+        type: WaitlistAppointmentResult
+  WaitlistAppointmentResult:
+    description: Waitlist Appointment Result
+    type: object
+    properties:
+      assignedResourceId:
+        description: Assigned Resource ID
+        required: false
+        type: string
+      serviceAppointmentId:
+        description: Service Appointment ID
+        type: string
+      waitlistParticipantId:
+        description: Waitlist Participant ID
+        required: false
+        type: string
+  WaitlistCheckInInputRepresentation:
+    description: Waitlist checkin input representation
+    type: object
+    properties:
+      description:
+        description: Description
+        required: false
+        type: string
+      lead:
+        description: Lead
+        required: false
+        type: object
+      participantId:
+        description: Participant Id
+        required: false
+        type: string
+      serviceResourceId:
+        description: Service Resource Id
+        required: false
+        type: string
+      waitlistId:
+        description: Waitlist Id
+        required: false
+        type: string
+      workTypeGroupId:
+        description: Work Type Group Id
+        required: false
+        type: string
+      workTypeId:
+        description: WorkType Id
+        required: false
+        type: string
+  WaitlistCheckInData: #TODO: hand-rolled
+    description: A wrapper around WaitlistCheckInInputRepresentation
+    type: object
+    properties:
+      waitlistCheckInInput:
+        description: The Oas Body name for waitlist checkIn data
+        type: WaitlistCheckInInputRepresentation
+  WaitlistCheckInOutputRepresentation:
+    description: Waitlist CheckIn output representation
+    type: object
+    properties:
+      result:
+        description: Waitlist CheckIn result
+        type: WaitlistCheckInResult
+  WaitlistCheckInResult:
+    description: Waitlist CheckIn Result
+    type: object
+    properties:
+      participantId:
+        description: Participant ID
+        required: false
+        type: string
+      serviceAppointmentId:
+        description: Service Appointment ID
+        type: string
+      waitlistParticipantId:
+        description: Waitlist Participant ID
+        required: false
+        type: string
+  WaitlistInputRepresentation:
+    description: Waitlist input representation
+    type: object
+    properties:
+      isActive:
+        description: IsActive
+        required: false
+        type: boolean
+      maxLimit:
+        description: Max Limit
+        required: false
+        type: integer
+      offset:
+        description: Offset
+        required: false
+        type: integer
+      requestId:
+        description: Request Unique Identifier
+        required: false
+        type: string
+      serviceTerritoryId:
+        description: ServiceTerritory Id
+        required: false
+        type: string
+      waitlistIds:
+        description: Waitlist Ids
+        required: false
+        type: array
+        items:
+          type: string
+  WaitlistListResult:
+    description: Waitlist list result
+    type: object
+    properties:
+      waitlists:
+        description: List of Waitlists
+        type: array
+        items:
+          type: WaitlistResult
+  WaitlistOutputRepresentation:
+    description: Output representation of Waitlist (List) Representation
+    type: object
+    properties:
+      result:
+        description: Waitlist result
+        type: WaitlistListResult
+  WaitlistParticipantParticipant:
+    description: Waitlist Participant Participant
+    type: object
+    properties:
+      id:
+        description: Id
+        required: false
+        type: string
+      name:
+        description: Name
+        required: false
+        type: string
+  WaitlistParticipantResult:
+    description: Waitlist Participant Result
+    type: object
+    properties:
+      participant:
+        description: Waitlist Participant
+        type: WaitlistParticipantParticipant
+        required: false
+      participantIdentifier:
+        description: Waitlist Participant Identifier
+        type: string
+        required: false
+      serviceAppointmentId:
+        description: Service Appointment ID
+        type: string
+      serviceResource:
+        description: Service Resource
+        type: WaitlistServiceResource
+        required: false
+      waitlistParticipantId:
+        description: Waitlist Participant ID
+        required: false
+        type: string
+      workTypeGroup:
+        description: Work Type Group
+        required: false
+        type: WaitlistWorkTypeGroup
+  WaitlistRelationshipsOutputRepresentation:
+    description: Output representation of Waitlist Relationships
+    type: object
+    properties:
+      result:
+        description: Waitlist Relationships result
+        type: WaitlistRelationshipsResult
+  WaitlistRelationshipsResult:
+    description: Waitlist Relationships Result
+    type: object
+    properties:
+      serviceResources:
+        description: Service Resources
+        required: false
+        type: array
+        items:
+          type: WaitlistServiceResource
+      workTypes:
+        description: Work Types
+        required: false
+        type: array
+        items:
+          type: WaitlistWorkType
+  WaitlistResult:
+    description: Waitlist result
+    type: object
+    properties:
+      description:
+        description: Description
+        required: false
+        type: string
+      isActive:
+        description: Active
+        required: false
+        type: boolean
+      name:
+        description: Waitlist Name
+        required: false
+        type: string
+      serviceResources:
+        description: Service Resources
+        required: false
+        type: array
+        items:
+          type: WaitlistServiceResource
+      waitlistAnalytics:
+        description: Waitlist Analytics
+        required: false
+        type: WaitlistAnalytics
+      waitlistId:
+        description: Waitlist ID
+        required: false
+        type: string
+      waitlistParticipants:
+        description: Waitlist Participants
+        required: false
+        type: array
+        items:
+          type: WaitlistParticipantResult
+      workTypeGroups:
+        description: Work Type Groups
+        required: false
+        type: array
+        items:
+          type: WaitlistWorkTypeGroup
+  WaitlistServiceResource:
+    description: Waitlist Service Resource
+    type: object
+    properties:
+      id:
+        description: Id
+        required: false
+        type: string
+      name:
+        description: Name
+        required: false
+        type: string
+  WaitlistServiceResourceWithWorkTypes:
+    description: Waitlist Service Resource With Work Types
+    type: object
+    properties:
+      id:
+        description: Id
+        type: string
+      serviceResourceId:
+        description: serviceResourceId
+        type: string
+      waitlistId:
+        description: waitlistId
+        type: string
+      workTypeIds:
+        description: workTypeIds
+        type: array
+        items:
+          type: string
+  WaitlistWorkType:
+    description: Waitlist Work Type
+    type: object
+    properties:
+      id:
+        description: Id
+        required: false
+        type: string
+      name:
+        description: Name
+        required: false
+        type: string
+      waitlist:
+        description: Waitlist
+        required: false
+        type: WaitlistResult
+      workTypeGroup:
+        description: Work Type Group
+        required: false
+        type: WaitlistWorkTypeGroup
+  WaitlistWorkTypeGroup:
+    description: Waitlist Work Type Group
+    type: object
+    properties:
+      id:
+        description: Id
+        required: false
+        type: string
+      name:
+        description: Name
+        required: false
+        type: string
+  WorkTypeInputRepresentation:
+    description: Work Type input representation
+    type: object
+    properties:
+      blockTimeAfterAppointmentInMinutes:
+        description: Block time after appointment
+        type: integer
+      blockTimeBeforeAppointmentInMinutes:
+        description: Block time before appointment
+        type: integer
+      durationInMinutes:
+        description: Duration in Minutes
+        type: integer
+      id:
+        description: Id
+        type: string
+      operatingHoursId:
+        description: Operating Hours Id
+        type: string
+      operatingHoursTimeZone:
+        description: Operating Hours Time Zone
+        type: string
+      skillRequirements:
+        description: Skill Requirement
+        type: array
+        items:
+          type: object
+      timeFrameEndInMinutes:
+        description: Timeframe end in minutes
+        type: integer
+      timeFrameStartInMinutes:
+        description: Timeframe start in minutes
+        type: integer
+
+/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
+    /next-waitlist-participant:
+      get:
+        displayName: getGetNextWaitlistParticipant
+        description: Get next waitlist participant with specified userid
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GetNextWaitlistParticipantOutputRepresentation
+        queryParameters:
+          userId:
+            type: string
+            required: false
+    /participant-recent-interactions:
+      get:
+        displayName: getParticipantRecentInteractions
+        description: Get recent interactions for given participant
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: ParticipantRecentInteractionsOutputRepresentation
+        queryParameters:
+          filterByResourceIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          participantId:
+            type: string
+            required: false
+          territoryId:
+            type: string
+            required: false
+    /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
+    /waitlist-appointments:
+      post:
+        displayName: postWaitlistAppointment
+        description: Waitlist Appointment
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: WaitlistAppointmentOutputRepresentation
+        body:
+          application/json:
+            type: WaitlistAppointmentData
+            (oas-body-name): waitlistAppointmentInput
+    /waitlist-checkin:
+      post:
+        displayName: postWaitlistCheckIn
+        description: Waitlist CheckIn
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: WaitlistCheckInOutputRepresentation
+        body:
+          application/json:
+            type: WaitlistCheckInData
+            (oas-body-name): waitlistCheckInInput
+    /waitlist-relationships:
+      get:
+        displayName: getWaitlistRelationships
+        description: Get work types or service resources related to a Waitlist
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: WaitlistRelationshipsOutputRepresentation
+        queryParameters:
+          serviceTerritoryId:
+            type: string
+            required: false
+          waitlistIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          workTypeIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+    /waitlists:
+      get:
+        displayName: getWaitlist
+        description: Waitlists
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: WaitlistOutputRepresentation
+        queryParameters:
+          isActive:
+            type: boolean
+            required: false
+          maxLimit:
+            type: integer
+            required: false
+          offset:
+            type: integer
+            required: false
+          requestId:
+            type: string
+            required: false
+          serviceTerritoryId:
+            type: string
+            required: false
+          waitlistIds:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv