@salesforce/lds-adapters-industries-education 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,703 @@
+#%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:
+  AvailableStaff:
+    description: Representation of the available staff result.
+    type: object
+    properties:
+      caseId:
+        description: The ID of the case that’s available to the staff member.
+        type: string
+        required: false
+      caseRecordTypeName:
+        description: The record type name of the case that's available to the staff
+          member.
+        type: string
+        required: false
+      caseTeamRole:
+        description: The staff member's case team role.
+        type: string
+        required: false
+      email:
+        description: The staff member's email.
+        type: string
+        required: false
+      lastServiceAppointment:
+        description: The last appointment completed by the staff member for the associated
+          account.
+        type: ServiceAppointment
+        required: false
+      locations:
+        description: The service locations in the staff member’s service territories
+          that are available for scheduling.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+      name:
+        description: The name of the staff member.
+        type: string
+        required: false
+      phone:
+        description: The staff member's phone number.
+        type: string
+        required: false
+      profilePhotoUrl:
+        description: The URL for the staff member's photo.
+        type: string
+        required: false
+      serviceResourceId:
+        description: The service resource ID for the staff.
+        type: string
+        required: false
+  AvailableTeam:
+    description: Representation of the available team result.
+    type: object
+    properties:
+      canSelfSchedule:
+        description: Indicates that a team is available for scheduling by the associated
+          account through Experience Cloud.
+        type: boolean
+        required: false
+      caseId:
+        description: The ID of the case that's related to the support of the associated
+          account.
+        type: string
+        required: false
+      caseRecordTypeName:
+        description: The record type name of the open case that's associated with
+          the account.
+        type: string
+        required: false
+      members:
+        description: List of staff members on the available team.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+      name:
+        description: The name of the team that's available to support the associated
+          account.
+        type: string
+        required: false
+      teamId:
+        description: The ID of the team that's available to support the associated
+          account.
+        type: string
+        required: false
+  AvailableTimeSlotsInputRepresentation:
+    description: Contains the information to search for available appointment time
+      slots.
+    type: object
+    properties:
+      endTime:
+        description: Latest time that an appointment can end.
+        type: string
+        required: false
+      engagementChannelTypeIds:
+        description: The IDs of the engagement channel type records. Time slot availability
+          is based on the selected engagement channel types.
+        type: array
+        items:
+          type: string
+      serviceResourceIds:
+        description: List of service resource IDs to filter the API response.
+        type: array
+        items:
+          type: string
+      serviceTerritoryIds:
+        description: List of IDs for the service territories where the work will be
+          performed.
+        type: array
+        items:
+          type: string
+      startTime:
+        description: Earliest time that an appointment can begin. If empty, the default
+          is the time of the request.
+        type: string
+        required: false
+      workTypeGroupId:
+        description: ID of the work type group containing the work types that are
+          being performed.
+        type: string
+  AvailableTimeSlotsInputRepresentationData: #TODO: hand-rolled
+    description: A wrapper around AvailableTimeSlotsInputRepresentation
+    type: object
+    properties:
+      availableTimeSlotsInput:
+        description: The Oas Body name for get available time slots
+        type: AvailableTimeSlotsInputRepresentation
+  AvailableTimeSlotsOuputRepresentation:
+    description: Output of the post available time slots request.
+    type: object
+    properties:
+      timeSlots:
+        description: List of time slots that are available for scheduling.
+        type: array
+        items:
+          type: TimeSlot
+  AvailableTopic:
+    description: Representation of the available topic.
+    type: object
+    properties:
+      parentWorkTypeGroupName:
+        description: The name of the parent work type group of the topic that represents
+          the available topic.
+        type: string
+        required: false
+      serviceTerritoryWorkTypes:
+        description: Details about the topic that's available for scheduling for the
+          related service territories.
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+      workTypeGroupId:
+        description: The ID of the work type group that represents the available topic.
+        type: string
+        required: false
+      workTypeGroupName:
+        description: The name of the work type group that represents the available
+          topic.
+        type: string
+        required: false
+  AvailableTopicsOutputRepresentation:
+    description: Output representation of the get available topics request.
+    type: object
+    properties:
+      topics:
+        description: List of topics that are available for scheduling.
+        type: array
+        items:
+          type: AvailableTopic
+  CarePlanBulkInputWrapperRepresentation:
+    #TODO Hand rolled due to W-8334626
+    description: Wrapper for careplan record input representation
+    type: object
+    properties:
+      carePlanBulkRecord:
+        type: CarePlanBulkInputRepresentation
+        description: Careplan bulk input representation
+  CarePlanBulkInputRepresentation:
+    description: Input representation for Care Plan Bulk
+    type: object
+    properties:
+      carePlans:
+        description: List of Care Plans for bulk
+        type: CarePlanListInputRepresentation
+  CarePlanBulkOutputRepresentation:
+    description: Bulk Output Representation
+    type: object
+    properties:
+      errorMessage:
+        description: API message
+        type: string
+        required: false
+      numberOfCarePlans:
+        description: Number of careplans submitted
+        type: integer
+        required: false
+      statusCode:
+        description: API code
+        type: string
+  CarePlanListInputRepresentation:
+    description: Input representation for List of Care Plans
+    type: object
+    properties:
+      records:
+        description: List of Care Plans
+        type: array
+        items:
+          type: CarePlanInputRepresentation
+  CarePlanInputRepresentation:
+    description: Input representation for Care Plan
+    type: object
+    properties:
+      benefitAssignments:
+        description: BenefitAssignments of the CarePlan
+        # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+        type: BenefitAssignmentListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      carePlanTasks:
+        description: Tasks for a Care Plan
+        type: CarePlanTaskInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      carePlanTemplateId:
+        description: CarePlanTemplateId of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      caseId:
+        description: CaseId of the CarePlan
+        type: string
+      customFields:
+        description: CustomFields of the CarePlan
+        type: CustomFieldListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      description:
+        description: Description of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      endDate:
+        description: EndDate of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      goalAssignments:
+        description: GoalAssignments of the CarePlan
+        # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+        type: GoalAssignmentListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      id:
+        description: Id of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      medicationTherapyReview:
+        description: MedicationTherapyReview of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      name:
+        description: Name of the CarePlan
+        type: string
+      participantId:
+        description: Participant of the CarePlan
+        type: string
+      startDate:
+        description: StartDate of the CarePlan
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Status of the CarePlan
+        type: string
+  GoalAssignmentInputRepresentation:
+    description: Input representation for GoalAssignment
+    type: object
+    properties:
+      completionDate:
+        description: CompletionDate of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      completionPercentage:
+        description: CompletionPercentage of the GoalAssignment
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      customFields:
+        description: CustomFields of the GoalAssignment
+        type: CustomFieldListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      description:
+        description: Description of the Goal Assignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      goalAssigneeId:
+        description: GoalAssigneeId of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      goalAssignmentTasks:
+        description: Tasks for Goal Assignment
+        type: CarePlanTaskInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      goalDefinitionId:
+        description: GoalDefinitionId of the GoalAssignment
+        type: string
+      id:
+        description: Id of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      priority:
+        description: Priority of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      startDate:
+        description: StartDate of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Status of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      targetCompletionDate:
+        description: TargetCompletionDate of the GoalAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      associatedBenefitAssignments:
+        description: Associated SubBenefit Assignments
+        type: BenefitAssignmentListInputRepresentation
+        required: false
+      associatedSubGoalAssignments:
+        description: Associated Sub Goal Assignments
+        type: GoalAssignmentListInputRepresentation
+        required: false
+  GoalAssignmentListInputRepresentation:
+    description: Input representation for List of GoalAssignment
+    type: object
+    properties:
+      records:
+        description: List of GoalAssignments
+        type: array
+        items:
+          # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          type: GoalAssignmentInputRepresentation
+  CarePlanTaskInputRepresentation:
+    description: Input representation for Care Plan Task
+    type: object
+    properties:
+      assignedTo:
+        description: Care Plan Task assignee
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      comment:
+        description: Care Plan Task comment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      dueDate:
+        description: Care Plan Task due date
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      id:
+        description: Id of the Task
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      priority:
+        description: Care Plan Task priority
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Care Plan Task Status
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      subject:
+        description: Care Plan Task subject
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      isRequired:
+        description: isRequired field for Task record
+        type: boolean
+        required: false
+  BenefitAssignmentInputRepresentation:
+    description: Input representation for BenefitAssignment
+    type: object
+    properties:
+      benefitAssignmentTasks:
+        description: Tasks for Benefit Assignment
+        type: CarePlanTaskInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      benefitDisbursements:
+        description: Benefit disbursements of the Benefit Assignment
+        type: BenefitDisbursementListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      benefitFrequency:
+        description: BenefitFrequency of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      benefitId:
+        description: Benefit Id of the Benefit
+        type: string
+      customFields:
+        description: CustomFields of the BenefitAssignment
+        type: CustomFieldListInputRepresentation
+        required: false # TODO Hand-rolled W-9314597
+      endDate:
+        description: EndDate of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      enrollmentCount:
+        description: EnrollmentCount of the BenefitAssignment
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      entitlementAmount:
+        description: EntitlementAmount of the BenefitAssignment
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      id:
+        description: Id of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      maximumAmount:
+        description: MaximumAmount of the BenefitAssignment
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      participantId:
+        description: ParticipantId of the BenefitAssignment
+        type: string
+      payoutFrequency:
+        description: PayoutFrequency of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      priority:
+        description: Priority of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      startDate:
+        description: StartDate of BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: Status of the BenefitAssignment
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  BenefitAssignmentListInputRepresentation:
+    description: Input representation for List of BenefitAssignments
+    type: object
+    properties:
+      records:
+        description: List of BenefitAssignments
+        type: array
+        items:
+          # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          type: BenefitAssignmentInputRepresentation
+  CustomFieldInputRepresentation:
+    description: Input representation for Custom Field
+    type: object
+    properties:
+      dataType:
+        description: Data Type of custom field
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+        enum:
+          - Boolean
+          - DateOnly
+          - DateTime
+          - MultiEnum
+          - Number
+          - String
+          - TimeOnly
+      fieldName:
+        description: Field Name of custom field
+        type: string
+      fieldValue:
+        description: Field Value of custom field
+        type: any
+  CustomFieldListInputRepresentation:
+    description: Input representation for List of CustomFields
+    type: object
+    properties:
+      records:
+        description: List of CustomFields
+        type: array
+        items:
+          # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          type: CustomFieldInputRepresentation
+  BenefitDisbursementForBenefitSessionInputRepresentation:
+    description: Input representation for Benefit Disbursement
+    type: object
+    properties:
+      actualCompletionDate:
+        description: date at which disbursement happened
+        type: string
+      benefitCategory:
+        description: Category of Benefit
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      benefitSessionId:
+        description: Benefit Session Id
+        type: string
+      description:
+        description: Description for Benefit Disbursement
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      disbursementStatus:
+        description: Benefit Disbursement Status
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      endDate:
+        description: date at which disbursement Ends
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      startDate:
+        description: date at which disbursement Starts
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  BenefitDisbursementListInputRepresentation:
+    description: Input representation for List of BenefitDisbursements
+    type: object
+    properties:
+      records:
+        description: List of Benefit Disbursements
+        type: array
+        items:
+          # TODO Hand-Rolled due to issue #16 in in Generated RAML Gaps (https://salesforce.quip.com/NxVhAkxL6RTW#dGQACAxyxIv)
+          type: BenefitDisbursementForBenefitSessionInputRepresentation
+  GetSuccessTeamResult:
+    description: Representation of the get success team request.
+    type: object
+    properties:
+      assignedStaff:
+        description: List of staff members who are assigned to the case and are available
+          to support the associated account.
+        type: object
+        properties:
+          //:
+            type: any
+      assignedTeams:
+        description: List of teams that are assigned to the case for the associated
+          account.
+        type: array
+        items:
+          type: AvailableTeam
+      unassignedTeams:
+        description: List of teams that aren't assigned to the case and are available
+          to support the associated account.
+        type: array
+        items:
+          type: AvailableTeam
+  ServiceAppointment:
+    description: Representation of the service appointment.
+    type: object
+    properties:
+      appointmentDate:
+        description: The date of the last service appointment.
+        type: string
+        required: false
+      serviceAppointmentId:
+        description: The ID of the last service appointment.
+        type: string
+        required: false
+      workTypeId:
+        description: The work type ID of the last service appointment.
+        type: string
+        required: false
+      workTypeName:
+        description: The work type name of the last service appointment.
+        type: string
+        required: false
+  ServiceLocation:
+    description: Representation of the service location result.
+    type: object
+    properties:
+      name:
+        description: The name of a service location in a service territory.
+        type: string
+        required: false
+      parentLocations:
+        description: List of parent locations associated with a location.
+        type: array
+        required: false
+        items:
+          type: string
+  SuccessTeamOutputRepresentation:
+    description: Output of the get success team request.
+    type: object
+    properties:
+      result:
+        description: Staff members and teams who are available to support the associated
+          account.
+        type: GetSuccessTeamResult
+  TimeSlot:
+    description: Representation of the time slot.
+    type: object
+    properties:
+      endTime:
+        description: The date and time that the time slot ends.
+        type: string
+        required: false
+      serviceResourceId:
+        description: ID of the service resource that's associated with the time slot.
+        type: string
+        required: false
+      serviceTerritoryId:
+        description: ID of the service territory that's associated with the time slot.
+        type: string
+        required: false
+      startTime:
+        description: The date and time that the time slot starts.
+        type: string
+        required: false
+  WorkType:
+    description: Representation of the work type.
+    type: object
+    properties:
+      workDurationType:
+        description: The units of time for the completion of the work.
+        type: string
+        required: false
+      workEstimatedDuration:
+        description: The length of time allocated for the completion of the work.
+        format: double
+        type: number
+        required: false
+      workTypeId:
+        description: The ID of the type of work to be performed.
+        type: string
+        required: false
+/connect/education:
+  /appointment-booking:
+    /available-time-slots:
+      post:
+        description: Returns a list of available appointment time slots for a resource
+          based on work type group and service territories.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AvailableTimeSlotsOuputRepresentation
+        body:
+          application/json:
+            type: AvailableTimeSlotsInputRepresentationData
+            (oas-body-name): availableTimeSlotsInput
+    /available-topics:
+      get:
+        description: Returns a list of available topics for scheduling.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: AvailableTopicsOutputRepresentation
+  /careplan/bulk:
+    post:
+      description: API to create CarePlans in bulk and it's related record
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CarePlanBulkOutputRepresentation
+      body:
+        #TODO Hand rolled due to W-8334626
+        application/json:
+          type: CarePlanBulkInputWrapperRepresentation
+          (oas-body-name): carePlanBulkRecord
+  /{accountId}/success-team:
+    get:
+      description: Returns a list of teams and staff that are available to support
+        an account.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SuccessTeamOutputRepresentation
+    uriParameters:
+      accountId:
+        type: string
+        required: true