naftiko: 1.0.0-alpha2
info:
  label: HipChat REST API v2 — Users
  description: HipChat Users capability (historical; sunset 2019-02-15).
  tags: [HipChat, Users, Sunset]
  created: '2026-05-23'
  modified: '2026-05-23'
  status: sunset
  sunsetDate: '2019-02-15'
binds:
- namespace: env
  keys:
    HIPCHAT_API_TOKEN: HIPCHAT_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: hipchat-users
    baseUri: https://api.hipchat.com/v2
    description: HipChat user directory operations.
    resources:
    - name: users
      path: /user
      operations:
      - name: listusers
        method: GET
        description: HipChat Get All Users
        outputRawFormat: json
        outputParameters: [{name: result, type: object, value: $.}]
        inputParameters:
        - {name: start-index, in: query, type: integer}
        - {name: max-results, in: query, type: integer}
        - {name: include-guests, in: query, type: boolean}
        - {name: include-deleted, in: query, type: boolean}
    - name: user
      path: /user/{id_or_email}
      operations:
      - {name: getuser, method: GET, description: HipChat Get User Details}
      - {name: updateuser, method: PUT, description: HipChat Update User}
      - {name: deleteuser, method: DELETE, description: HipChat Delete User}
    - name: user-private-message
      path: /user/{id_or_email}/message
      operations:
      - {name: sendprivatemessage, method: POST, description: HipChat Send Private Message}
    authentication:
      type: bearer
      token: '{{env.HIPCHAT_API_TOKEN}}'
  exposes:
  - type: rest
    namespace: hipchat-users-rest
    port: 8080
    description: REST adapter for HipChat Users.
    resources:
    - path: /v1/users
      name: users
      operations:
      - {method: GET, name: listusers, call: hipchat-users.listusers}
    - path: /v1/users/{id_or_email}
      name: user
      operations:
      - {method: GET, name: getuser, call: hipchat-users.getuser}
      - {method: PUT, name: updateuser, call: hipchat-users.updateuser}
      - {method: DELETE, name: deleteuser, call: hipchat-users.deleteuser}
    - path: /v1/users/{id_or_email}/message
      name: user-private-message
      operations:
      - {method: POST, name: sendprivatemessage, call: hipchat-users.sendprivatemessage}