openapi: 3.1.0
info:
  title: Comunidesk API — Comunicaciones
  version: 1.0.0
  description: Comunicaciones enviadas a residentes.
servers:
  - url: "https://gateway.comunidesk.com"
    description: Gateway producción
tags:
  - name: comunicaciones
    description: Comunicaciones — Comunicaciones enviadas a residentes.
paths:
  /v1/rest/Comunicaciones:
    get:
      tags:
        - comunicaciones
      operationId: listComunicacion
      summary: Listar Comunicaciones
      description: Comunicaciones enviadas a residentes.
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
          description: Contexto de edificio (requerido en la mayoría de módulos).
        - name: $filter
          in: query
          required: false
          schema:
            type: string
          description: "Filtro OData, p.ej. edificioId eq 'abc'"
        - name: $top
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: $skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Comunicacion"
                  count:
                    type: integer
        401:
          description: Token inválido
        403:
          description: Sin permiso
    post:
      tags:
        - comunicaciones
      operationId: createComunicacion
      summary: Crear Comunicaciones
      security:
        - OAuth2App: []
          ComunideskUser: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Comunicacion"
      responses:
        200:
          description: Creado
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Comunicacion"
        403:
          description: Sin permiso
        422:
          description: Contrato inválido
  /v1/rest/Comunicaciones/{id}:
    get:
      tags:
        - comunicaciones
      operationId: getComunicacion
      summary: Obtener Comunicaciones
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
          description: Contexto de edificio (requerido en la mayoría de módulos).
        - name: $filter
          in: query
          required: false
          schema:
            type: string
          description: "Filtro OData, p.ej. edificioId eq 'abc'"
        - name: $top
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
        - name: $skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Comunicacion"
        404:
          description: No encontrado
    patch:
      tags:
        - comunicaciones
      operationId: updateComunicacion
      summary: Actualizar Comunicaciones
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Comunicacion"
      responses:
        200:
          description: Actualizado
        403:
          description: Sin permiso
        422:
          description: Contrato inválido
    delete:
      tags:
        - comunicaciones
      operationId: deleteComunicacion
      summary: Eliminar Comunicaciones
      security:
        - OAuth2App: []
          ComunideskUser: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: edificioId
          in: query
          required: false
          schema:
            type: string
      responses:
        200:
          description: Eliminado
        403:
          description: Sin permiso
        404:
          description: No encontrado
components:
  securitySchemes:
    OAuth2App:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token OAuth2 de tu aplicación.
    ComunideskUser:
      type: apiKey
      in: header
      name: x-comunidesk-user-authorization
      description: "Bearer <JWT de la cuenta Comunidesk del usuario>."
  schemas:
    Comunicacion:
      type: object
      description: Comunicaciones enviadas a residentes.
      properties:
        _id:
          type: string
        _rev:
          type: string
        type:
          type: string
          const: comunicacion
        edificioId:
          type: string
        asunto:
          type: string
        cuerpo:
          type: string
        canal:
          type: string
          enum:
            - email
            - push
            - sms
            - interno
        destinatarios:
          type: array
          items: {}
        fechaEnvio:
          type: string
        createdAt:
          type: string
          readOnly: true
        updatedAt:
          type: string
          readOnly: true
      required:
        - edificioId
        - asunto
        - cuerpo
    OAuthScopes:
      type: string
      enum:
        - "comunidesk:read"
        - "comunidesk:write"
        - "files:pdf"
        - "files:excel"
        - "ai:models"
        - "ai:chat"
        - "ai:extract"
        - "ai:web"
        - "flex-pro:manage"
        - "flex-pro:runtime"
        - "flex-pro:marketplace"
      description: Scopes OAuth soportados por el gateway.
security:
  - OAuth2App: []
    ComunideskUser: []