@salesforce/lds-adapters-industries-healthcloud 0.131.0

package/src/raml/api.raml

@@ -0,0 +1,699 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '56.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:
+  GenericConnectApiGETOutputRepresentation:
+    description: Output representation of Generic Connect API for GET
+    type: object
+    properties:
+      code:
+        description: Generic API GET returned code
+        type: string
+        required: false
+      message:
+        description: Generic API GET Message
+        type: string
+      rowSpecificOutput:
+        description: Generic API GET List of Records
+        type: array
+        required: false
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+      searchTerm:
+        description: Generic API GET Search Term
+        type: string
+  GenericConnectApiPOSTInputRepresentation:
+    description: Generic API POST Input Representation
+    type: object
+    properties:
+      recordList:
+        description: List of records to be created for each entity
+        type: object
+        #required: false
+        properties:
+          //:
+            type: array
+            items:
+              type: any
+  GenericConnectApiPOSTInputRepresentationWrapper:
+    description: Wrapper for Generic Connect API POST Input Representation
+    type: object
+    properties:
+      GenericConnectApiPOSTInput:
+        type: GenericConnectApiPOSTInputRepresentation
+        description: Generic API POST Input Representation
+  GenericConnectApiPOSTOutputRepresentation:
+    description: Output representation of Generic Connect API for POST
+    type: object
+    properties:
+      code:
+        description: Generic API POST returned code
+        type: string
+        required: false
+      createdIds:
+        description: Generic API POST List of Created Records
+        type: object
+        required: false
+        properties:
+          //:
+            type: array
+            items:
+              type: any
+      message:
+        description: Generic API POST Message
+        type: string
+  GetSlotsInputRepresentation:
+    description: Input representation for get Slots API
+    type: object
+    properties:
+      endTime:
+        description: End Time
+        type: string
+        required: false
+      searchConditions:
+        description: Search Conditions List
+        type: array
+        items:
+          type: SearchConditionInputRepresentation
+      startTime:
+        description: Start Time
+        type: string
+      workProcedureId:
+        description: Work Procedure Id
+        type: string
+        required: false
+  GetSlotsOutputRepresentation:
+    description: List of available slots
+    type: object
+    properties:
+      code:
+        description: Get Slots Status code
+        type: string
+      isSuccess:
+        description: Get Slots API Status flag
+        type: boolean
+      message:
+        description: Get Slots API Error Message
+        type: string
+        required: false
+      workTypeDateTerritorySlotRepresentation:
+        description: WorkTypeDateTerritorySlotRepresentation
+        type: object
+        required: false
+        properties:
+          //:
+            type: object
+            required: false
+            properties:
+              //:
+                type: array
+                required: false
+                items:
+                  type: any # TODO Hand-rolled W-8863405
+  SearchConditionInputRepresentation:
+    description: Wraps Search Condition
+    type: object
+    properties:
+      serviceTerritoryIds:
+        description: List of Service Territory IDs
+        type: array
+        items:
+          type: string
+      workTypeId:
+        description: List of Work Type IDs
+        type: string
+  CancelSlotChainInputRepresentation:
+    description: Input Representation for Cancel Slot Chain API
+    type: object
+    properties:
+      cancelationReason:
+        description: Set Cancelation Reason
+        type: string
+        required: false
+      serviceAppointmentGroupId:
+        description: Set serviceAppointmentGroupId
+        type: string
+        required: false
+      slots:
+        description: Set Slots
+        type: array
+        items:
+          type: string
+        required: false
+      status:
+        description: Set Status
+        type: string
+  CancelSlotChainOutputRepresentation:
+    description: Output Representation for Cancel Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Cancel Slot Chain Code
+        type: string
+      isSuccess:
+        description: Cancel Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Cancel Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentIds:
+        description: Cancel Slot Chain API Service Appointment Ids
+        type: array
+        items:
+          type: string
+  GetSlotsInputRepresentationWrapper:
+    description: Wrapper for Get Slots input representation
+    type: object
+    properties:
+      getSlotsInput:
+        type: GetSlotsInputRepresentation
+        description: Get Slots Input representation
+  SlotInputRepresentation:
+    description: Input Representation for Slots
+    type: object
+    properties:
+      additionalInformation:
+        description: Set Additional Information
+        type: string
+        required: false
+      appointmentType:
+        description: Set Appointment Type
+        type: string
+        required: false
+      city:
+        description: Set City
+        type: string
+        required: false
+      comments:
+        description: Set Comments
+        type: string
+        required: false
+      contactId:
+        description: Set Contact Id
+        type: string
+        required: false
+      country:
+        description: Set Country
+        type: string
+        required: false
+      description:
+        description: Set Description
+        type: string
+        required: false
+      postalCode:
+        description: Set Postal Code
+        type: string
+        required: false
+      schedEndTime:
+        description: Set SchedEndTime
+        type: string
+      schedStartTime:
+        description: Set SchedStartTime
+        type: string
+      serviceResourceId:
+        description: Set Service Resource Id
+        type: string
+        required: false
+      serviceTerritoryId:
+        description: Set Service Territory Id
+        type: string
+      state:
+        description: Set State
+        type: string
+        required: false
+      status:
+        description: Set Status
+        type: string
+      street:
+        description: Set Street
+        type: string
+        required: false
+      subject:
+        description: Set Subject
+        type: string
+        required: false
+      workTypeId:
+        description: Set WorkType Id
+        type: string
+        required: false
+  BookSlotChainInputRepresentation:
+    description: Input Representation for Book Slot Chain
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+      slots:
+        description: Set Slots
+        type: array
+        items:
+          type: SlotInputRepresentation
+      workProcedureId:
+        description: Set Work Procedure
+        type: string
+  BookSlotChainInputRepresentationWrapper:
+    description: Wrapper for Book Slots input representation
+    type: object
+    properties:
+      BookSlotChainInput:
+        type: BookSlotChainInputRepresentation
+        description: Book Slots Input representation
+  BookSlotChainOutputRepresentation:
+    description: Output Representation for Book Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Book Slot Chain Code
+        type: string
+      isSuccess:
+        description: Book Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Book Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentGroupId:
+        description: Book Slot Chain Service Appointment Group Id
+        type: string | nil
+        required: false
+      serviceAppointmentIds:
+        description: Book Slot Chain API Service Appointment Ids
+        type: array
+        required: false
+        items:
+          type: string
+  CancelSlotChainInputRepresentationWrapper:
+    description: Wrapper for Cancel Slot Chain input representation
+    type: object
+    properties:
+      CancelSlotChainInput:
+        type: CancelSlotChainInputRepresentation
+        description: Cancel Slot Chain Input representation
+  RescheduleSlotChainInputRepresentation:
+    description: Input Representation for Reschedule Slot Chain
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+      workProcedureId:
+        description: Set Work Procedure
+        type: string
+      newSlotsInputRepresentation:
+        description: Set New Slots for Book
+        type: array
+        items:
+          type: SlotInputRepresentation
+      status:
+        description: Set Status of Group
+        type: string
+        required: false
+      rescheduleReason:
+        description: Set Reschedule Reason
+        type: string
+        required: false
+      serviceAppointmentGroupIdRescheduledSlots:
+        description: Set Service Appointment Group ID of Rescheduling Slots
+        type: string
+      serviceAppointmentIdsRescheduledSlots:
+        description: Set Service Appointment IDs of Rescheduling Slots
+        type: array
+        items:
+          type: string
+  RescheduleSlotChainInputRepresentationWrapper:
+    description: Wrapper for Reschedule Slot Chain Input Representation
+    type: object
+    properties:
+      RescheduleSlotChainInput:
+        type: RescheduleSlotChainInputRepresentation
+        description: Reschedule Slot Chain Input representation
+  RescheduleSlotChainOutputRepresentation:
+    description: Output Representation for Reschedule Slot Chain API
+    type: object
+    properties:
+      code:
+        description: Reschedule Slot Chain Code
+        type: string
+      isSuccess:
+        description: Reschedule Slot Chain API Status flag
+        type: boolean
+      message:
+        description: Reschedule Slot Chain API Error Message
+        type: string | nil
+        required: false
+      serviceAppointmentGroupIdBookedSlots:
+        description: Reschedule Slot Chain Service Appointment Group Id of Newly Booked Slots
+        type: string | nil
+        required: false
+      serviceAppointmentIdsBookedSlots:
+        description: Reschedule Slot Chain API Service Appointment Ids of Newly Booked Slots
+        type: array
+        required: false
+        items:
+          type: string
+  ServiceTerritoryRepresentation:
+    description: Service Territory Representation
+    type: object
+    properties:
+      serviceTerritoryID:
+        description: Service Territory ID
+        type: string
+      serviceTerritoryName:
+        description: Service Territory Name
+        type: string
+  FetchServiceTerritoriesInputRepresentation:
+    description: Input representation for Fetch Service Territories API
+    type: object
+    properties:
+      transplantCenterId:
+        description: Transplant Center ID
+        type: string
+      workProcedureId:
+        description: Work Procedure ID
+        type: string
+      workTypeIds:
+        description: List of WorkType IDs
+        type: array
+        items:
+          type: string
+  FetchServiceTerritoriesInputRepresentationWrapper:
+    description: Wrapper for Fetch Service Territory input representation
+    type: object
+    properties:
+      getWorkTypeServiceTerritories:
+        type: FetchServiceTerritoriesInputRepresentation
+        description: Fetch Service Territory Input representation
+  FetchServiceTerritoriesOutputRepresentation:
+    description: List Service Territories
+    type: object
+    properties:
+      code:
+        description: Fetch Service Territories Status code
+        type: string
+      isSuccess:
+        description: Fetch Service Territories Status flag
+        type: boolean
+      message:
+        description: Fetch Service Territories API Error Message
+        type: string
+        required: false
+      workTypeServiceTerritoryMap:
+        description: Map of WorkTypeId and Service Territories
+        type: object
+        required: false
+        properties:
+          //:
+            type: any
+  FetchEntityDetailsSearchConditionInputRepresentation:
+    description: Fetch entity details Search Condition
+    type: object
+    properties:
+      field:
+        description: Set entity Field Name
+        type: string
+        required: false
+      operand:
+        description: Set operand
+        type: string
+        required: false
+      value:
+        description: Set entity Value Name
+        type: any
+        required: false
+  FetchEntityDetailsInputRepresentation:
+    description: Input Representation for fetch entity details api
+    type: object
+    properties:
+      elevatedMode:
+        description: Set elevated Mode
+        type: boolean
+        required: false
+      entityApiName:
+        description: Set entity Api Name
+        type: string
+      filterLogic:
+        description: Set filter Logic
+        type: string
+      queryFieldsList:
+        description: Set Query Fields List
+        type: array
+        items:
+          type: string
+      whereConditionList:
+        description: Set entity condition list
+        type: array
+        required: false
+        items:
+          type: FetchEntityDetailsSearchConditionInputRepresentation
+  FetchEntityDetailsOutputRepresentation:
+    description: Output Representation for fetch entity details api
+    type: object
+    properties:
+      code:
+        description: Get Generic Entity Output API Code
+        type: string
+      fieldsToValueMap:
+        description: Get Generic Entity Output Records Map
+        type: object
+        properties:
+          //:
+            type: object
+            properties:
+              //:
+                type: any
+      isSuccess:
+        description: Get Generic Entity API Status flag
+        type: boolean
+      message:
+        description: Get Generic Entity Output API Error Message
+        type: string | nil
+        required: false
+  FetchEntityDetailsInputRepresentationWrapper:
+    description: Wrapper for fetch entity details input representation
+    type: object
+    properties:
+      fetchEntityDetailsInputParam:
+        type: FetchEntityDetailsInputRepresentation
+        description: Fetch Entity Details Input representation
+  MoveToNextStepInputRepresentation:
+    description: Input Representation for Move To Next Step API
+    type: object
+    properties:
+      careProgramEnrolleeId:
+        description: Set Care Program Enrollee Id
+        type: string
+  MoveToNextStepInputRepresentationWrapper:
+    description: Wrapper for Move To Next Step input representation
+    type: object
+    properties:
+      MoveToNextStepInput:
+        type: MoveToNextStepInputRepresentation
+        description: Move To Next Step Input representation
+  MoveToNextStepOutputRepresentation:
+    description: Move To Next Step API representation
+    type: object
+    properties:
+      code:
+        description: Move To Next Step Status code
+        type: string
+      isSuccess:
+        description: Move To Next Step API Status flag
+        type: boolean
+      lastUpdatedWorkOrder:
+        description: Last updated work order
+        type: string
+      lastUpdatedWorkOrderStep:
+        description: Last updated work order step
+        type: string
+      message:
+        description: Move To Next Step Error Message
+        type: string | nil
+      nextWorkOrder:
+        description: Next Work Order
+        type: string
+      nextWorkOrderStep:
+        description: Next Work Order Step
+        type: string
+
+/connect:
+  /health:
+    /generic/{context}:
+      get:
+        description: Generic Connect API GET Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericConnectApiGETOutputRepresentation
+        queryParameters:
+          fields:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          limitBy:
+            type: string
+            required: false
+          offset:
+            type: string
+            required: false
+          searchTerm:
+            type: string
+            required: false
+          sortBy:
+            type: string
+            required: false
+          sortOrder:
+            type: string
+            required: false
+          values:
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      post:
+        description: Generic Connect API POST Resource
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: GenericConnectApiPOSTOutputRepresentation
+        body:
+          application/json:
+            type: GenericConnectApiPOSTInputRepresentationWrapper
+            #required: false
+            (oas-body-name): GenericConnectApiPOSTInput
+      uriParameters:
+        context:
+          type: string
+          required: true
+    /advanced-therapy-management:
+      /get-slots:
+        post:
+          description: Fetch Available Slots
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: GetSlotsOutputRepresentation
+          body:
+            application/json:
+              type: GetSlotsInputRepresentationWrapper
+              #required: false
+              (oas-body-name): getSlotsInput
+      /book-slot-chain:
+        post:
+          description: Book Slot Chain API Resource
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: BookSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: BookSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): BookSlotChainInput
+      /cancel-slot-chain:
+        post:
+          description: Cancel slot chain
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: CancelSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: CancelSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): CancelSlotChainInput
+      /reschedule-slot-chain:
+        post:
+          description: Reschedule Slot Chain
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: RescheduleSlotChainOutputRepresentation
+          body:
+            application/json:
+              type: RescheduleSlotChainInputRepresentationWrapper
+              #required: false
+              (oas-body-name): RescheduleSlotChainInput
+      /fetch-service-territories:
+        post:
+          description: API to fetch Service Territories data
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: FetchServiceTerritoriesOutputRepresentation
+          body:
+            application/json:
+              type: FetchServiceTerritoriesInputRepresentationWrapper
+              #required: false
+              (oas-body-name): getWorkTypeServiceTerritories
+      /move-to-next-step:
+        post:
+          description: Move to next step
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: MoveToNextStepOutputRepresentation
+          body:
+            application/json:
+              type: MoveToNextStepInputRepresentationWrapper
+              #required: false
+              (oas-body-name): MoveToNextStepInput
+    /fetch-entity-details:
+      post:
+        description: Fetch Entity Details
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: FetchEntityDetailsOutputRepresentation
+        body:
+          application/json:
+            type: FetchEntityDetailsInputRepresentationWrapper
+            #required: false
+            (oas-body-name): fetchEntityDetailsInputParam