Eden Health grdn.routes.impl.channel API

swagger: '2.0'
info:
  version: null
  title: Grdn grdn.handler grdn.routes.impl.channel API
  description: Eden Health Inc. primary backend API service.
consumes:
- application/json
produces:
- application/json
tags:
- name: grdn.routes.impl.channel
  description: Contains handlers for routes related to Channels.
paths:
  /v2/channel/{channel-id}:
    put:
      summary: update-channel-handler
      description: Updates the status of a channel. Used by clinical front end for manual updates.
      tags:
      - grdn.routes.impl.channel
      parameters:
      - in: path
        name: channel-id
        description: 'origin spec: grdn.specs.channel/update-channel-params'
        required: true
        type: string
        format: uuid
      - in: body
        name: grdn.specs.channel/update-channel-params
        description: 'origin spec: grdn.specs.channel/update-channel-params'
        schema:
          type: object
          properties:
            status:
              enum:
              - archived
              - open
              - pending
              type: string
          required:
          - status
          title: grdn.specs.channel/update-channel-params
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/channel/{channel-id}/message/{message-id}/delete:
    post:
      summary: delete-message-handler
      description: "Updates a message custom type to deleted and changes content to empty string.\n   If message is an image, deletes the image from S3.\n   If message is a document, soft-deletes the document from our database, while keeping it in S3.\n   If deleting message and image are successful, logs an event about the deleted message to the db."
      tags:
      - grdn.routes.impl.channel
      parameters:
      - in: path
        name: channel-id
        description: 'origin spec: grdn.specs.channel/delete-message-params'
        required: true
        type: string
        format: uuid
      - in: path
        name: message-id
        description: 'origin spec: grdn.specs.channel/delete-message-params'
        required: true
        type: integer
        format: int64
      - in: body
        name: grdn.specs.channel/delete-message-params
        description: 'origin spec: grdn.specs.channel/delete-message-params'
        schema:
          type: object
          properties:
            unread:
              type: boolean
            patient-id:
              type: string
              format: uuid
            deleted-reason:
              enum:
              - ''
              - wrong-patient
              - duplicate
              - irrelevant
              type: string
              allowEmptyValue: true
            document-id:
              type: string
              format: uuid
            sent-at:
              type: integer
              format: int64
            content:
              type: string
            image-id:
              type: string
              format: uuid
            provider-sender-id:
              type: string
              format: uuid
          required:
          - patient-id
          title: grdn.specs.channel/delete-message-params
      responses:
        default:
          description: Default success response.
          schema: {}
  /v2/patient/{patient-id}/get-unread:
    get:
      summary: get-patient-primary-channel-unread-messages-handler
      description: ''
      tags:
      - grdn.routes.impl.channel
      parameters:
      - in: path
        name: patient-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: true
        type: string
        format: uuid
      - in: query
        name: funnel-id
        description: 'origin spec: grdn.specs/patient-id-params'
        required: false
        type: string
        format: uuid
      responses:
        default:
          description: Default success response.
          schema:
            type: object
            properties:
              unread-message-count:
                type: integer
                format: int64
            required:
            - unread-message-count
            title: grdn.specs.channel/get-patient-primary-channel-unread-messages-response