openapi: "3.0.3"
    info:
      title: "API Entrega de Medios"
      description: Actualización del estatus de entrega de token para los diferentes proveedores de mensajería.
      version: "1.0.0"
    servers:
      - url: https://api-sandbox.banorte.com/api/esb
        description: Servidor de Sandbox.
    security:
      - oAuth2ClientCredentials:
        - update
    paths:
      /Accesorios/mensajeria:
        post:
          tags:
            - "Actualización de estatus de entrega de Token"
          summary: Actualiza el estatus de entrega del Token
          description: Actualiza la información del estado de entrega del token por la mensajería.
          parameters: 
          - $ref: "#/components/parameters/Accept-LanguageId"
          - $ref: "#/components/parameters/Authorization"
          requestBody:
            content:
              application/json:
                schema:
                  $ref: "#/components/schemas/bodyRequestToken"
            required: true
          responses:
            200:
              description: Regresa el resultado de la actualización de la entrega de token.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseToken"
            400:
              description: Se regresa cuando la petición no cumple con especificado en el api.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            401:
              description: Se regresa este mensaje cuando envían un token invalido.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            403:
              description: Se regresa cuando no se envía un token expirado o sin privilegios.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            405:
              description: Se regresa cuando envían un método diferente especificado en la API.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            406:
              description: Se regresa cuando envían un valor incorrecto en el encabezado de aceptación.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            408:
              description: Se regresa cuando las peticiones generan timeout.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            429:
              description: Se regresa cuando el recurso se ejecuta con demasiada frecuencia.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            431:
              description: Se regresa cuando envían demasiada información en los encabezados.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            500:
              description: Se regresa cuando sucede un error Interno en el servidor.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
            503:
              description: Se regresa cuando las APIS están inactivas.
              content:
                application/json:
                  schema:
                    $ref: "#/components/schemas/bodyResponseTokenError"
    components:
      securitySchemes:
        oAuth2ClientCredentials:
          type: oauth2
          description: |
            La API debe requerir un encabezado de autorización en la solicitud http un token web JSON (JWT) emitido por el servidor de autorización Oauth2 aprobado por la empresa para la autenticación del servicio.
          flows:
            clientCredentials:
              tokenUrl: "/api/esb/ValidaCredenciales/accesstoken"
              scopes:
                update: Permisos para actualizar el estatus de la entrega.
      schemas:
        bodyResponseToken:
          allOf:
          - $ref: "#/components/schemas/resultadoGenerico"
          - $ref: "#/components/schemas/resultadoToken"
        bodyResponseTokenError:
          allOf:
          - $ref: "#/components/schemas/resultadoGenerico"
          - $ref: "#/components/schemas/resultadoGenericoError"
        bodyRequestToken:
          type: object
          properties:
            solicitud:
              type: object
              properties:
                idMensaje:
                  title: Id Mensanje
                  description: Identificador de la mensajería que realiza la entrega.
                  type: integer
                  maximum: 999999
                  minimum: 0
                  example: 1
                idEntrega:
                  title: Id Entrega
                  description: Identificador del envío.
                  type: integer
                  maximum: 9999999999999999999999999
                  minimum: 0
                  example: 676394232
                numeroGuia:
                  title: Numero Guia
                  description: Número de seguimiento para el Cliente.
                  type: string
                  maxLength: 100
                  minLength: 1
                  example: C7E-814-886
                fechaEntrega:
                  title: Fecha de Entrega
                  description: Fecha y hora en que se entrega el paquete aaaa-mm-ddThh:mm:ss.
                  type: string
                  format: date-time
                  example: "2021-12-10T12:15:45"
                numIntentos:
                  title: Numero de Intentos
                  description: Número total de intentos.
                  type: integer
                  maximum: 99
                  minimum: 0
                  example: 1
                nombrePersona:
                  title: Nombre Persona
                  description: Nombre de la persona que recibe el paquete.
                  type: string
                  maxLength: 150
                  minLength: 1
                  example: Folanito Perez
                claveEstatus:
                  title: Clave Estatus
                  description: Clave estatus de la entrega.
                  type: integer
                  maximum: 999999
                  minimum: 0
                  example: 3
                descEstatus:
                  title: Descripcion Estatus
                  description: Descripción del estatus actual de la entrega.
                  type: string
                  maxLength: 50
                  minLength: 1
                  example: Orden Asignada
                comentarios:
                  title: Comentarios
                  description: Comentario complementario al estatus de la entrega.
                  type: string
                  maxLength: 255
                  minLength: 1
                  example: COMENTARIO DE LA ENTREGA
              required:
                - idMensaje
                - numeroGuia
                - fechaEntrega
                - claveEstatus
                - descEstatus

        resultadoToken:
          description: Contiene los campos de resultado de la ejecución del api.
          type: object
          properties:
            resultado:
              title: Resultado de la API
              description:  Elemento que contiene los campos que regresa el api cuando se ejecuta con éxito.
              type: object
              properties:
                idEntrega:
                  title: Id Entrega.
                  description: Identificador.
                  type: integer
                  maximum: 999999999999999999999999
                  minimum: 0
                  example: 1
                mensaje:
                  title: Mensaje.
                  description: Mensaje de Confirmación.
                  type: string
                  maxLength: 150
                  minLength: 1
                  example: Token Entregado.

        resultadoGenerico:
          type: object
          properties:
            status:
              title: Status
              description: Contiene el código de respuesta.
              type: integer
              maximum: 999
              minimum: 0
              example: 200
              enum:
                - 200
                - 400
                - 401
                - 403
                - 405
                - 406
                - 408
                - 429
                - 431
                - 500
                - 503
            codigoRespuesta:
              title: Codigo de Respuesta
              description: Identifica si la petición se ejecutó con éxito o error 0 - Error de Negocio. 1 - Proceso correcto.
              type: integer
              maximum: 9
              minimum: 0
              example: 0
              enum:
                - 0
                - 1
            codigoError:
              title: Codigo de Respuesta
              description: Identificador del código de error para la aplicación cliente.
              type: string
              maxLength: 20
              minLength: 1
              example: ERRNEG001
              enum:
                - "ERRNEG001 -Error de Negocio."
                - "ERRESQ001 - Cuando el JSON que viaje en el body no es válido."
                - "ERRESQ002 -Cuando envían campos vacíos o nulos."
                - "ERRESQ003 -Cuando se envían campos que no están definidos en la API."
                - "ERRESQ004 -Cuando la longitud de un campo es mayor o menor a lo establecido en la API."
                - "ERRESQ005 -Cuando en la petición envían un tipo de dato diferente en los campos de la API."
                - "ERRESQ006 -Cuando no envían campos requeridos de la API."
                - "ERRSEG001 -Cuando en la petición envían un token invalido."
                - "ERRSEG002 -Cuando en la petición envían un token expirado."
                - "ERRSEG003 -Cuando en la petición envían un token sin privilegios."
                - "ERRSEG004 -Cuando envían un método diferente especificado en la API."
                - "ERRSEG005 -Cuando envían un valor incorrecto en el encabezado de aceptación."
                - "ERRSEG006 -Cuando el recurso se ejecuta con demasiada frecuencia."
                - "ERRSEG007 -Cuando envían demasiada información en los encabezados."
                - "ERRSER001 -Cuando las peticiones generan timeout."
                - "ERRSER002 -Cuando las peticiones generan un error en los equipos de Banorte."
                - "ERRSER003 -Cuando los equipos de APIS no tienen conexión con Banorte."
                - "ERROFF001 -Cuando se apaga la funcionalidad de una API."
                - "ERROFF002 -Cuando se apaga la funcionalidad de todas las API."
            folio:
              title: Folio
              type: string
              description: Identificador global único generado automáticamente para cada petición recibida.
              maxLength: 36
              minLength: 1
              example: 08API1642005180146
            mensaje:
              title: Mensaje de la operación.
              description: Contiene la descripción del resultado de ejecución de la API.
              type: string
              maxLength: 500
              minLength: 1
              example: Proceso de Entrega.

        resultadoGenericoError:
          description: Contiene los campos de resultado de la ejecución del api.
          type: object
          properties:
            detalles:
              title: Detalles del error
              description: Elemento que contiene los campos que explican el error sucedido.
              type: object
              properties:
                enlace:
                  title: Enlace URL.
                  description: URL que indica donde se puede obtener la solución del error.
                  type: string
                  maxLength: 300
                  minLength: 1
                  example: https://developers.banorte.com/es/faq
                propiedad:
                  title: Mensaje.
                  description: Mensaje de error.
                  type: string
                  maxLength: 300
                  minLength: 1
                  example: Json Invalido.
                valorIncorrecto:
                  title: Valor Incorrecto.
                  description: Campo que se utiliza para indicar que campo contiene información incorrecta en la petición.
                  type: string
                  maxLength: 50
                  minLength: 1
                  example: Campo1.
              
      parameters:
        Accept-LanguageId:
          name: accept-Language
          in: header
          required: false
          schema:
            type: string
            maxLength: 5
            minLength: 1
            enum:
              - "es_MX"
              - "en_US"
          description: 'Indica el idioma natural y la configuración regional que prefiere el cliente. Valores Posibles: es_MX, en_US'
          example: "es_MX"

        Authorization:
          name: Authorization
          in: header
          required: true
          schema:
            type: string
          description: 'El Bearer es el Token de autenticación, es una cadena generada por el servidor en respuesta a una solicitud de autenticación al ejecutar el recurso de oauth 2.0'
          example: "Bearer token"