{ "openapi": "3.0.0", "info": { "title": "Dylema Delivery API", "description": "Documentación interactiva y oficial de los servicios de la API de Dylema.", "version": "1.0.0" }, "servers": [ { "url": "https://api.dylema.dev", "description": "Servidor de Producción" }, { "url": "http://localhost:3000", "description": "Servidor de Desarrollo Local" } ], "paths": { "/api/auth/login": { "post": { "summary": "Iniciar sesión en autenticación", "description": "Permite realizar operaciones relacionadas con iniciar sesión en autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } } }, "/api/auth/parsedBody": { "get": { "summary": "Listar parsedbody de autenticación", "description": "Permite realizar operaciones relacionadas con listar parsedbody de autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/auth/logout": { "post": { "summary": "Crear logout de autenticación", "description": "Permite realizar operaciones relacionadas con crear logout de autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } } }, "/api/auth/profile": { "get": { "summary": "Obtener perfil de autenticación", "description": "Permite realizar operaciones relacionadas con obtener perfil de autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/auth/verify-invitation": { "get": { "summary": "Verificar en autenticación", "description": "Permite realizar operaciones relacionadas con verificar en autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/auth/set-password": { "post": { "summary": "Crear set password de autenticación", "description": "Permite realizar operaciones relacionadas con crear set password de autenticación en el módulo Auth.", "tags": [ "Auth" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema.dev" }, "password": { "type": "string", "example": "miPasswordSuperSeguro123" } } }, "example": { "email": "admin@dylema.dev", "password": "miPasswordSuperSeguro123" } } } } } }, "/api/cdrs": { "get": { "summary": "Listar cdrs", "description": "Permite realizar operaciones relacionadas con listar cdrs en el módulo Cdrs.", "tags": [ "Cdrs" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de cdrs" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cdrs/{id}": { "get": { "summary": "Obtener cdrs por ID", "description": "Permite realizar operaciones relacionadas con obtener cdrs por id en el módulo Cdrs.", "tags": [ "Cdrs" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de cdrs" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de cdrs" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/checkouts": { "post": { "summary": "Crear checkout", "description": "Permite realizar operaciones relacionadas con crear checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "get": { "summary": "Listar checkouts", "description": "Permite realizar operaciones relacionadas con listar checkouts en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/checkouts/parsedBody": { "get": { "summary": "Listar parsedbody de checkouts", "description": "Permite realizar operaciones relacionadas con listar parsedbody de checkouts en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/checkouts/{id}": { "get": { "summary": "Obtener checkout por ID", "description": "Permite realizar operaciones relacionadas con obtener checkout por id en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ] } }, "/api/checkouts/{id}/approve": { "patch": { "summary": "Aprobar de checkout", "description": "Permite realizar operaciones relacionadas con aprobar de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } } }, "/api/checkouts/{id}/reject": { "patch": { "summary": "Rechazar de checkout", "description": "Permite realizar operaciones relacionadas con rechazar de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } } }, "/api/checkouts/{id}/approve-payment": { "patch": { "summary": "Aprobar de checkout", "description": "Permite realizar operaciones relacionadas con aprobar de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } } }, "/api/checkouts/{id}/reject-payment": { "patch": { "summary": "Rechazar de checkout", "description": "Permite realizar operaciones relacionadas con rechazar de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } } }, "/api/checkouts/{id}/fulfillment-status": { "patch": { "summary": "Actualizar entrega status de checkout", "description": "Permite realizar operaciones relacionadas con actualizar entrega status de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "DELIVERED" } } }, "example": { "status": "DELIVERED" } } } } } }, "/api/checkouts/{id}/register-payment": { "patch": { "summary": "Actualizar register pago de checkout", "description": "Permite realizar operaciones relacionadas con actualizar register pago de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentMethodId": { "type": "string", "example": "ef8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "reference": { "type": "string", "example": "TRANS-889900" }, "amount": { "type": "number", "example": 169 }, "approve": { "type": "boolean", "example": true } } }, "example": { "paymentMethodId": "ef8b88cc-5b12-42bb-92dd-a99f36f4d259", "reference": "TRANS-889900", "amount": 169, "approve": true } } } } } }, "/api/checkouts/{id}/report-payment": { "patch": { "summary": "Actualizar report pago de checkout", "description": "Permite realizar operaciones relacionadas con actualizar report pago de checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "currency": { "type": "string", "example": "USD" }, "subtotal": { "type": "number", "example": 150 }, "tax": { "type": "number", "example": 24 }, "discount": { "type": "number", "example": 10 }, "shippingCost": { "type": "number", "example": 5 }, "total": { "type": "number", "example": 169 }, "isRecurring": { "type": "boolean", "example": false }, "productServicePlanId": { "type": "string", "example": "a9e623cd-9430-4eeb-b639-68ea9f135b44" }, "warehouseId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "items": { "type": "array", "items": { "type": "object" } }, "metadata": { "type": "object", "properties": { "canal_venta": { "type": "string", "example": "web_publico" }, "campana_ref": { "type": "string", "example": "google_ads" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "currency": "USD", "subtotal": 150, "tax": 24, "discount": 10, "shippingCost": 5, "total": 169, "isRecurring": false, "productServicePlanId": "a9e623cd-9430-4eeb-b639-68ea9f135b44", "warehouseId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "items": [ { "productVersionId": "b11a7a6c-94cd-498c-8f19-33aa8bb21359", "quantity": 1, "unitPrice": 150 } ], "metadata": { "canal_venta": "web_publico", "campana_ref": "google_ads" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de checkout", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentMethodId": { "type": "string", "example": "ef8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "reference": { "type": "string", "example": "PAGO-MOVIL-9938" }, "amount": { "type": "number", "example": 169 } } }, "example": { "paymentMethodId": "ef8b88cc-5b12-42bb-92dd-a99f36f4d259", "reference": "PAGO-MOVIL-9938", "amount": 169 } } } } } }, "/api/checkouts/admin/reset-all-sales": { "delete": { "summary": "Restablecer admin en checkout", "description": "Permite realizar operaciones relacionadas con restablecer admin en checkout en el módulo Checkouts.", "tags": [ "Checkouts" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/currencies": { "get": { "summary": "Listar monedas", "description": "Permite realizar operaciones relacionadas con listar monedas en el módulo Currencies.", "tags": [ "Currencies" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "code": "USD", "name": "Dólar Estadounidense", "symbol": "$" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/currencies/{id}": { "get": { "summary": "Obtener moneda por ID", "description": "Permite realizar operaciones relacionadas con obtener moneda por id en el módulo Currencies.", "tags": [ "Currencies" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "code": { "type": "string", "example": "USD" }, "name": { "type": "string", "example": "Dólar Estadounidense" }, "symbol": { "type": "string", "example": "$" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "code": "USD", "name": "Dólar Estadounidense", "symbol": "$" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/customers": { "get": { "summary": "Listar clientes", "description": "Permite realizar operaciones relacionadas con listar clientes en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear cliente", "description": "Permite realizar operaciones relacionadas con crear cliente en el módulo Customers.", "tags": [ "Customers" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } } }, "/api/customers/uploads": { "get": { "summary": "Listar procesos de carga de de clientes", "description": "Permite realizar operaciones relacionadas con listar procesos de carga de de clientes en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/customers/{id}": { "get": { "summary": "Obtener cliente por ID", "description": "Permite realizar operaciones relacionadas con obtener cliente por id en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar cliente", "description": "Permite realizar operaciones relacionadas con actualizar cliente en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "put": { "summary": "Actualizar cliente", "description": "Permite realizar operaciones relacionadas con actualizar cliente en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "delete": { "summary": "Eliminar cliente", "description": "Permite realizar operaciones relacionadas con eliminar cliente en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/customers/upload": { "post": { "summary": "Subir archivo de cliente", "description": "Permite realizar operaciones relacionadas con subir archivo de cliente en el módulo Customers.", "tags": [ "Customers" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "Juan" }, "lastName": { "type": "string", "example": "Pérez" }, "email": { "type": "string", "example": "juan.perez@example.com" }, "phone": { "type": "string", "example": "+584121234567" }, "document": { "type": "string", "example": "V-12345678" } } }, "example": { "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } } } } } }, "/api/customers/parsedBody": { "get": { "summary": "Listar parsedbody de clientes", "description": "Permite realizar operaciones relacionadas con listar parsedbody de clientes en el módulo Customers.", "tags": [ "Customers" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "firstName": "Juan", "lastName": "Pérez", "email": "juan.perez@example.com", "phone": "+584121234567", "document": "V-12345678" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/merchants/current/api-key": { "get": { "summary": "Listar current api key de comercios", "description": "Permite realizar operaciones relacionadas con listar current api key de comercios en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear current api key de comercio", "description": "Permite realizar operaciones relacionadas con crear current api key de comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } } }, "/api/merchants/current": { "get": { "summary": "Listar current de comercios", "description": "Permite realizar operaciones relacionadas con listar current de comercios en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "summary": "Actualizar current de comercio", "description": "Permite realizar operaciones relacionadas con actualizar current de comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } } }, "/api/merchants": { "get": { "summary": "Listar comercios", "description": "Permite realizar operaciones relacionadas con listar comercios en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear comercio", "description": "Permite realizar operaciones relacionadas con crear comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } } }, "/api/merchants/modules": { "get": { "summary": "Listar modules de comercios", "description": "Permite realizar operaciones relacionadas con listar modules de comercios en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/merchants/modules/{module}/resources": { "get": { "summary": "Obtener modules resources de comercio", "description": "Permite realizar operaciones relacionadas con obtener modules resources de comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "module", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/merchants/config": { "get": { "summary": "Listar config de comercios", "description": "Permite realizar operaciones relacionadas con listar config de comercios en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/merchants/{id}": { "get": { "summary": "Obtener comercio por ID", "description": "Permite realizar operaciones relacionadas con obtener comercio por id en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar comercio", "description": "Permite realizar operaciones relacionadas con actualizar comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "put": { "summary": "Actualizar comercio", "description": "Permite realizar operaciones relacionadas con actualizar comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "delete": { "summary": "Eliminar comercio", "description": "Permite realizar operaciones relacionadas con eliminar comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/merchants/{id}/resend-invitation": { "post": { "summary": "Reenviar en comercio", "description": "Permite realizar operaciones relacionadas con reenviar en comercio en el módulo Merchants.", "tags": [ "Merchants" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Comercio Dylema Caracas" }, "subdomain": { "type": "string", "example": "dylema-caracas" }, "adminUser": { "type": "object", "properties": { "email": { "type": "string", "example": "admin@dylema-caracas.dev" }, "firstName": { "type": "string", "example": "Pedro" }, "lastName": { "type": "string", "example": "Ramírez" } } } } }, "example": { "name": "Comercio Dylema Caracas", "subdomain": "dylema-caracas", "adminUser": { "email": "admin@dylema-caracas.dev", "firstName": "Pedro", "lastName": "Ramírez" } } } } } } }, "/api/permissions": { "get": { "summary": "Listar permisos", "description": "Permite realizar operaciones relacionadas con listar permisos en el módulo Permissions.", "tags": [ "Permissions" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "support-cases:list", "description": "Permite listar casos de soporte" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products/uploads": { "get": { "summary": "Listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products/uploads/{id}/reprocess": { "post": { "summary": "Reprocesar carga de Listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con reprocesar carga de listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/exports": { "get": { "summary": "Listar procesos de exportación de de productos", "description": "Permite realizar operaciones relacionadas con listar procesos de exportación de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products/export": { "post": { "summary": "Exportar de producto", "description": "Permite realizar operaciones relacionadas con exportar de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/upload": { "post": { "summary": "Subir archivo de producto", "description": "Permite realizar operaciones relacionadas con subir archivo de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/stocks/uploads": { "get": { "summary": "Listar stock listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con listar stock listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products/stocks/uploads/{id}/reprocess": { "post": { "summary": "Reprocesar carga de stock de Listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con reprocesar carga de stock de listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/stocks/upload": { "post": { "summary": "Subir archivo de stock de producto", "description": "Permite realizar operaciones relacionadas con subir archivo de stock de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/images/uploads": { "get": { "summary": "Listar imágenes listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con listar imágenes listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products/images/uploads/{id}/reprocess": { "post": { "summary": "Reprocesar carga de imágenes de Listar procesos de carga de de productos", "description": "Permite realizar operaciones relacionadas con reprocesar carga de imágenes de listar procesos de carga de de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/images/upload": { "post": { "summary": "Subir archivo de imágenes de producto", "description": "Permite realizar operaciones relacionadas con subir archivo de imágenes de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/stocks/batch-update": { "post": { "summary": "Actualizar stock de producto", "description": "Permite realizar operaciones relacionadas con actualizar stock de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products": { "get": { "summary": "Listar productos", "description": "Permite realizar operaciones relacionadas con listar productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear producto", "description": "Permite realizar operaciones relacionadas con crear producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/categories": { "get": { "summary": "Listar categorías de productos", "description": "Permite realizar operaciones relacionadas con listar categorías de productos en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear categorías de producto", "description": "Permite realizar operaciones relacionadas con crear categorías de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/categories/{id}": { "put": { "summary": "Actualizar categorías de producto", "description": "Permite realizar operaciones relacionadas con actualizar categorías de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "delete": { "summary": "Eliminar categorías de producto", "description": "Permite realizar operaciones relacionadas con eliminar categorías de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/products/{id}": { "get": { "summary": "Obtener producto por ID", "description": "Permite realizar operaciones relacionadas con obtener producto por id en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar producto", "description": "Permite realizar operaciones relacionadas con actualizar producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "put": { "summary": "Actualizar producto", "description": "Permite realizar operaciones relacionadas con actualizar producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "delete": { "summary": "Eliminar producto", "description": "Permite realizar operaciones relacionadas con eliminar producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/products/pictures/{id}": { "delete": { "summary": "Eliminar imágenes de producto", "description": "Permite realizar operaciones relacionadas con eliminar imágenes de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/products/{id}/pictures/reorder": { "patch": { "summary": "Reordenar imágenes en producto", "description": "Permite realizar operaciones relacionadas con reordenar imágenes en producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/{id}/versions": { "get": { "summary": "Obtener versiones de producto", "description": "Permite realizar operaciones relacionadas con obtener versiones de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "post": { "summary": "Crear versiones de producto", "description": "Permite realizar operaciones relacionadas con crear versiones de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/{id}/pictures": { "post": { "summary": "Crear imágenes de producto", "description": "Permite realizar operaciones relacionadas con crear imágenes de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/versions/{id}": { "patch": { "summary": "Actualizar versiones de producto", "description": "Permite realizar operaciones relacionadas con actualizar versiones de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "put": { "summary": "Actualizar versiones de producto", "description": "Permite realizar operaciones relacionadas con actualizar versiones de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "delete": { "summary": "Eliminar versiones de producto", "description": "Permite realizar operaciones relacionadas con eliminar versiones de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/products/versions/{id}/pictures": { "post": { "summary": "Crear versiones imágenes de producto", "description": "Permite realizar operaciones relacionadas con crear versiones imágenes de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/versions/pictures/{id}": { "delete": { "summary": "Eliminar versiones imágenes de producto", "description": "Permite realizar operaciones relacionadas con eliminar versiones imágenes de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/products/versions/{id}/stock/adjust": { "post": { "summary": "Ajustar versiones de stock en producto", "description": "Permite realizar operaciones relacionadas con ajustar versiones de stock en producto en el módulo Products.", "tags": [ "Products" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } } }, "/api/products/versions/{id}/stock/logs": { "get": { "summary": "Obtener versiones stock historial de producto", "description": "Permite realizar operaciones relacionadas con obtener versiones stock historial de producto en el módulo Products.", "tags": [ "Products" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plan de Fibra Óptica 100 Mbps" }, "description": { "type": "string", "example": "Internet simétrico residencial de alta velocidad" }, "price": { "type": "number", "example": 45 }, "sku": { "type": "string", "example": "FIBRA-100M-RES" }, "productCategoryId": { "type": "string", "example": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "description": "Internet simétrico residencial de alta velocidad", "price": 45, "sku": "FIBRA-100M-RES", "productCategoryId": "c1a9ee5d-32bb-48ff-98ee-e9aa68fb599d" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/public/products": { "get": { "summary": "Listar productos públicos", "description": "Permite realizar operaciones relacionadas con listar productos públicos en el módulo Public Products.", "tags": [ "Public Products" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plan de Fibra Óptica 100 Mbps", "price": 45, "sku": "FIBRA-100M-RES" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } } } }, "/api/product-categories/public/{merchantId}": { "get": { "summary": "Obtener public de categoría de producto", "description": "Permite realizar operaciones relacionadas con obtener public de categoría de producto en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } }, "parameters": [ { "name": "merchantId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/product-categories": { "get": { "summary": "Listar categorías de producto", "description": "Permite realizar operaciones relacionadas con listar categorías de producto en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear categoría de producto", "description": "Permite realizar operaciones relacionadas con crear categoría de producto en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } } }, "/api/product-categories/{id}": { "get": { "summary": "Obtener categoría de producto por ID", "description": "Permite realizar operaciones relacionadas con obtener categoría de producto por id en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar categoría de producto", "description": "Permite realizar operaciones relacionadas con actualizar categoría de producto en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Internet Fibra" }, "description": { "type": "string", "example": "Planes de conexión a internet por fibra óptica" } } }, "example": { "name": "Internet Fibra", "description": "Planes de conexión a internet por fibra óptica" } } } } }, "delete": { "summary": "Eliminar categoría de producto", "description": "Permite realizar operaciones relacionadas con eliminar categoría de producto en el módulo Product Categories.", "tags": [ "Product Categories" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/roles": { "get": { "summary": "Listar roles", "description": "Permite realizar operaciones relacionadas con listar roles en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear rol", "description": "Permite realizar operaciones relacionadas con crear rol en el módulo Roles.", "tags": [ "Roles" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } } }, "/api/roles/resources": { "get": { "summary": "Listar resources de roles", "description": "Permite realizar operaciones relacionadas con listar resources de roles en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/roles/{id}": { "get": { "summary": "Obtener rol por ID", "description": "Permite realizar operaciones relacionadas con obtener rol por id en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar rol", "description": "Permite realizar operaciones relacionadas con actualizar rol en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "put": { "summary": "Actualizar rol", "description": "Permite realizar operaciones relacionadas con actualizar rol en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Agente de Soporte Nivel 2" }, "permissions": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "Agente de Soporte Nivel 2", "permissions": [ "support-cases:list", "support-cases:get", "support-cases:edit" ] } } } } }, "delete": { "summary": "Eliminar rol", "description": "Permite realizar operaciones relacionadas con eliminar rol en el módulo Roles.", "tags": [ "Roles" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/users/switch-merchant": { "post": { "summary": "Crear switch comercio de usuario", "description": "Permite realizar operaciones relacionadas con crear switch comercio de usuario en el módulo Users.", "tags": [ "Users" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } } }, "/api/users/assignees": { "get": { "summary": "Listar assignees de usuarios", "description": "Permite realizar operaciones relacionadas con listar assignees de usuarios en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/users": { "get": { "summary": "Listar usuarios", "description": "Permite realizar operaciones relacionadas con listar usuarios en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear usuario", "description": "Permite realizar operaciones relacionadas con crear usuario en el módulo Users.", "tags": [ "Users" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } } }, "/api/users/{id}": { "get": { "summary": "Obtener usuario por ID", "description": "Permite realizar operaciones relacionadas con obtener usuario por id en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar usuario", "description": "Permite realizar operaciones relacionadas con actualizar usuario en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "put": { "summary": "Actualizar usuario", "description": "Permite realizar operaciones relacionadas con actualizar usuario en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "soporte.agente@dylema.dev" }, "firstName": { "type": "string", "example": "María" }, "lastName": { "type": "string", "example": "Gómez" }, "roleId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" }, "userGroupId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } }, "example": { "email": "soporte.agente@dylema.dev", "firstName": "María", "lastName": "Gómez", "roleId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344", "userGroupId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" } } } } }, "delete": { "summary": "Eliminar usuario", "description": "Permite realizar operaciones relacionadas con eliminar usuario en el módulo Users.", "tags": [ "Users" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/product-service-plans": { "get": { "summary": "Listar product service plans", "description": "Permite realizar operaciones relacionadas con listar product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear product service plans", "description": "Permite realizar operaciones relacionadas con crear product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "name": "Ejemplo de product service plans" } } } } } }, "/api/product-service-plans/{id}": { "get": { "summary": "Obtener product service plans por ID", "description": "Permite realizar operaciones relacionadas con obtener product service plans por id en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar product service plans", "description": "Permite realizar operaciones relacionadas con actualizar product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "name": "Ejemplo de product service plans" } } } } }, "put": { "summary": "Actualizar product service plans", "description": "Permite realizar operaciones relacionadas con actualizar product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "name": "Ejemplo de product service plans" } } } } }, "delete": { "summary": "Eliminar product service plans", "description": "Permite realizar operaciones relacionadas con eliminar product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/product-service-plans/customer-association": { "post": { "summary": "Crear cliente association de product service plans", "description": "Permite realizar operaciones relacionadas con crear cliente association de product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "name": "Ejemplo de product service plans" } } } } } }, "/api/product-service-plans/customer-association/{id}": { "delete": { "summary": "Eliminar cliente association de product service plans", "description": "Permite realizar operaciones relacionadas con eliminar cliente association de product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/product-service-plans/customer/{customerId}": { "get": { "summary": "Obtener cliente de product service plans", "description": "Permite realizar operaciones relacionadas con obtener cliente de product service plans en el módulo Product Service Plans.", "tags": [ "Product Service Plans" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de product service plans" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de product service plans" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivrs/tts/preview": { "post": { "summary": "Crear tts preview de ivr", "description": "Permite realizar operaciones relacionadas con crear tts preview de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivrs/tts/confirm": { "post": { "summary": "Crear tts confirm de ivr", "description": "Permite realizar operaciones relacionadas con crear tts confirm de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivrs": { "get": { "summary": "Listar ivr", "description": "Permite realizar operaciones relacionadas con listar ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear ivr", "description": "Permite realizar operaciones relacionadas con crear ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivrs/detail/{id}": { "get": { "summary": "Obtener detail de ivr", "description": "Permite realizar operaciones relacionadas con obtener detail de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivrs/nodes": { "post": { "summary": "Crear nodes de ivr", "description": "Permite realizar operaciones relacionadas con crear nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivrs/nodes/{id}": { "patch": { "summary": "Actualizar nodes de ivr", "description": "Permite realizar operaciones relacionadas con actualizar nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } }, "delete": { "summary": "Eliminar nodes de ivr", "description": "Permite realizar operaciones relacionadas con eliminar nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivrs/routes": { "post": { "summary": "Crear routes de ivr", "description": "Permite realizar operaciones relacionadas con crear routes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivrs/routes/{id}": { "delete": { "summary": "Eliminar routes de ivr", "description": "Permite realizar operaciones relacionadas con eliminar routes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivrs/{did}": { "get": { "summary": "Obtener ivr por ID", "description": "Permite realizar operaciones relacionadas con obtener ivr por id en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "did", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivr-config/tts/preview": { "post": { "summary": "Crear tts preview de ivr", "description": "Permite realizar operaciones relacionadas con crear tts preview de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivr-config/tts/confirm": { "post": { "summary": "Crear tts confirm de ivr", "description": "Permite realizar operaciones relacionadas con crear tts confirm de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivr-config": { "get": { "summary": "Listar ivr", "description": "Permite realizar operaciones relacionadas con listar ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear ivr", "description": "Permite realizar operaciones relacionadas con crear ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivr-config/detail/{id}": { "get": { "summary": "Obtener detail de ivr", "description": "Permite realizar operaciones relacionadas con obtener detail de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivr-config/nodes": { "post": { "summary": "Crear nodes de ivr", "description": "Permite realizar operaciones relacionadas con crear nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivr-config/nodes/{id}": { "patch": { "summary": "Actualizar nodes de ivr", "description": "Permite realizar operaciones relacionadas con actualizar nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } }, "delete": { "summary": "Eliminar nodes de ivr", "description": "Permite realizar operaciones relacionadas con eliminar nodes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivr-config/routes": { "post": { "summary": "Crear routes de ivr", "description": "Permite realizar operaciones relacionadas con crear routes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "name": "Ejemplo de ivr" } } } } } }, "/api/ivr-config/routes/{id}": { "delete": { "summary": "Eliminar routes de ivr", "description": "Permite realizar operaciones relacionadas con eliminar routes de ivr en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/ivr-config/{did}": { "get": { "summary": "Obtener ivr por ID", "description": "Permite realizar operaciones relacionadas con obtener ivr por id en el módulo Ivr.", "tags": [ "Ivr" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de ivr" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de ivr" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "did", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/sip-trunks": { "get": { "summary": "Listar sip trunks", "description": "Permite realizar operaciones relacionadas con listar sip trunks en el módulo Sip Trunks.", "tags": [ "Sip Trunks" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de sip trunks" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear sip trunks", "description": "Permite realizar operaciones relacionadas con crear sip trunks en el módulo Sip Trunks.", "tags": [ "Sip Trunks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de sip trunks" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de sip trunks" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de sip trunks" } } }, "example": { "name": "Ejemplo de sip trunks" } } } } } }, "/api/sip-trunks/{id}": { "get": { "summary": "Obtener sip trunks por ID", "description": "Permite realizar operaciones relacionadas con obtener sip trunks por id en el módulo Sip Trunks.", "tags": [ "Sip Trunks" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de sip trunks" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de sip trunks" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar sip trunks", "description": "Permite realizar operaciones relacionadas con actualizar sip trunks en el módulo Sip Trunks.", "tags": [ "Sip Trunks" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de sip trunks" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de sip trunks" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de sip trunks" } } }, "example": { "name": "Ejemplo de sip trunks" } } } } }, "delete": { "summary": "Eliminar sip trunks", "description": "Permite realizar operaciones relacionadas con eliminar sip trunks en el módulo Sip Trunks.", "tags": [ "Sip Trunks" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/dids": { "get": { "summary": "Listar dids", "description": "Permite realizar operaciones relacionadas con listar dids en el módulo Dids.", "tags": [ "Dids" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de dids" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear dids", "description": "Permite realizar operaciones relacionadas con crear dids en el módulo Dids.", "tags": [ "Dids" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de dids" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de dids" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de dids" } } }, "example": { "name": "Ejemplo de dids" } } } } } }, "/api/dids/{id}": { "get": { "summary": "Obtener dids por ID", "description": "Permite realizar operaciones relacionadas con obtener dids por id en el módulo Dids.", "tags": [ "Dids" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de dids" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de dids" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar dids", "description": "Permite realizar operaciones relacionadas con actualizar dids en el módulo Dids.", "tags": [ "Dids" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Ejemplo de dids" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Ejemplo de dids" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Ejemplo de dids" } } }, "example": { "name": "Ejemplo de dids" } } } } } }, "/api/extensions": { "get": { "summary": "Listar extensiones", "description": "Permite realizar operaciones relacionadas con listar extensiones en el módulo Extensions.", "tags": [ "Extensions" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "number": "1001", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "password": "extension_password_1001" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear extensión", "description": "Permite realizar operaciones relacionadas con crear extensión en el módulo Extensions.", "tags": [ "Extensions" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "number": { "type": "string", "example": "1001" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "password": { "type": "string", "example": "extension_password_1001" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "number": "1001", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "password": "extension_password_1001" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string", "example": "1001" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "password": { "type": "string", "example": "extension_password_1001" } } }, "example": { "number": "1001", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "password": "extension_password_1001" } } } } } }, "/api/extensions/user/{userId}": { "get": { "summary": "Obtener usuario de extensión", "description": "Permite realizar operaciones relacionadas con obtener usuario de extensión en el módulo Extensions.", "tags": [ "Extensions" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "number": { "type": "string", "example": "1001" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "password": { "type": "string", "example": "extension_password_1001" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "number": "1001", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "password": "extension_password_1001" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/extensions/{id}": { "delete": { "summary": "Eliminar extensión", "description": "Permite realizar operaciones relacionadas con eliminar extensión en el módulo Extensions.", "tags": [ "Extensions" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/stages": { "get": { "summary": "Listar etapas de oportunidades", "description": "Permite realizar operaciones relacionadas con listar etapas de oportunidades en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear etapas de oportunidad", "description": "Permite realizar operaciones relacionadas con crear etapas de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/stages/{id}": { "put": { "summary": "Actualizar etapas de oportunidad", "description": "Permite realizar operaciones relacionadas con actualizar etapas de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "delete": { "summary": "Eliminar etapas de oportunidad", "description": "Permite realizar operaciones relacionadas con eliminar etapas de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/stages/template": { "post": { "summary": "Crear etapas plantilla de oportunidad", "description": "Permite realizar operaciones relacionadas con crear etapas plantilla de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/types": { "get": { "summary": "Listar tipos de oportunidades", "description": "Permite realizar operaciones relacionadas con listar tipos de oportunidades en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear tipos de oportunidad", "description": "Permite realizar operaciones relacionadas con crear tipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/types/{id}": { "put": { "summary": "Actualizar tipos de oportunidad", "description": "Permite realizar operaciones relacionadas con actualizar tipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "delete": { "summary": "Eliminar tipos de oportunidad", "description": "Permite realizar operaciones relacionadas con eliminar tipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/types/batch": { "post": { "summary": "Crear tipos lote de oportunidad", "description": "Permite realizar operaciones relacionadas con crear tipos lote de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/types/{typeId}/eligible-agents": { "get": { "summary": "Obtener tipos eligible agents de oportunidad", "description": "Permite realizar operaciones relacionadas con obtener tipos eligible agents de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/types/{typeId}/subtypes": { "post": { "summary": "Crear tipos subtipos de oportunidad", "description": "Permite realizar operaciones relacionadas con crear tipos subtipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/types/{typeId}/subtypes/{id}": { "put": { "summary": "Actualizar tipos subtipos de oportunidad", "description": "Permite realizar operaciones relacionadas con actualizar tipos subtipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "delete": { "summary": "Eliminar tipos subtipos de oportunidad", "description": "Permite realizar operaciones relacionadas con eliminar tipos subtipos de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/types/{typeId}/subtypes/batch": { "post": { "summary": "Crear tipos subtipos lote de oportunidad", "description": "Permite realizar operaciones relacionadas con crear tipos subtipos lote de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities": { "get": { "summary": "Listar oportunidades", "description": "Permite realizar operaciones relacionadas con listar oportunidades en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear oportunidad", "description": "Permite realizar operaciones relacionadas con crear oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } } }, "/api/opportunities/{id}": { "get": { "summary": "Obtener oportunidad por ID", "description": "Permite realizar operaciones relacionadas con obtener oportunidad por id en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar oportunidad", "description": "Permite realizar operaciones relacionadas con actualizar oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "delete": { "summary": "Eliminar oportunidad", "description": "Permite realizar operaciones relacionadas con eliminar oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/opportunities/{id}/history": { "get": { "summary": "Obtener historial de oportunidad", "description": "Permite realizar operaciones relacionadas con obtener historial de oportunidad en el módulo Opportunities.", "tags": [ "Opportunities" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Adquisición de Enlace de Fibra" }, "description": { "type": "string", "example": "Cliente interesado en enlace dedicado de 100 Mbps" }, "value": { "type": "number", "example": 1500 }, "status": { "type": "string", "example": "OPEN" }, "stageId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Adquisición de Enlace de Fibra", "description": "Cliente interesado en enlace dedicado de 100 Mbps", "value": 1500, "status": "OPEN", "stageId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/user-groups": { "get": { "summary": "Listar grupos de usuarios", "description": "Permite realizar operaciones relacionadas con listar grupos de usuarios en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear grupo de usuarios", "description": "Permite realizar operaciones relacionadas con crear grupo de usuarios en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } } }, "/api/user-groups/{id}": { "get": { "summary": "Obtener grupo de usuarios por ID", "description": "Permite realizar operaciones relacionadas con obtener grupo de usuarios por id en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar grupo de usuarios", "description": "Permite realizar operaciones relacionadas con actualizar grupo de usuarios en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "put": { "summary": "Actualizar grupo de usuarios", "description": "Permite realizar operaciones relacionadas con actualizar grupo de usuarios en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Equipo Técnico Caracas" }, "description": { "type": "string", "example": "Agentes encargados de incidencias en la zona metropolitana" } } }, "example": { "name": "Equipo Técnico Caracas", "description": "Agentes encargados de incidencias en la zona metropolitana" } } } } }, "delete": { "summary": "Eliminar grupo de usuarios", "description": "Permite realizar operaciones relacionadas con eliminar grupo de usuarios en el módulo User Groups.", "tags": [ "User Groups" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/support-cases/types": { "get": { "summary": "Listar tipos de casos de soporte", "description": "Permite realizar operaciones relacionadas con listar tipos de casos de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear tipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/types/batch": { "post": { "summary": "Crear tipos lote de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos lote de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/types/{id}": { "put": { "summary": "Actualizar tipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con actualizar tipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "delete": { "summary": "Eliminar tipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con eliminar tipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/support-cases/types/{typeId}/subtypes": { "post": { "summary": "Crear tipos subtipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos subtipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/types/{typeId}/subtypes/batch": { "post": { "summary": "Crear tipos subtipos lote de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos subtipos lote de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/types/{typeId}/subtypes/{id}": { "put": { "summary": "Actualizar tipos subtipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con actualizar tipos subtipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "delete": { "summary": "Eliminar tipos subtipos de caso de soporte", "description": "Permite realizar operaciones relacionadas con eliminar tipos subtipos de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/support-cases/types/{typeId}/stages": { "get": { "summary": "Obtener tipos etapas de caso de soporte", "description": "Permite realizar operaciones relacionadas con obtener tipos etapas de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "post": { "summary": "Crear tipos etapas de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos etapas de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/types/{typeId}/stages/{id}": { "put": { "summary": "Actualizar tipos etapas de caso de soporte", "description": "Permite realizar operaciones relacionadas con actualizar tipos etapas de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "delete": { "summary": "Eliminar tipos etapas de caso de soporte", "description": "Permite realizar operaciones relacionadas con eliminar tipos etapas de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/support-cases/types/{typeId}/stages/template": { "post": { "summary": "Crear tipos etapas plantilla de caso de soporte", "description": "Permite realizar operaciones relacionadas con crear tipos etapas plantilla de caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases": { "get": { "summary": "Listar casos de soporte", "description": "Permite realizar operaciones relacionadas con listar casos de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear caso de soporte", "description": "Permite realizar operaciones relacionadas con crear caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } } }, "/api/support-cases/{id}": { "get": { "summary": "Obtener caso de soporte por ID", "description": "Permite realizar operaciones relacionadas con obtener caso de soporte por id en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar caso de soporte", "description": "Permite realizar operaciones relacionadas con actualizar caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "title": { "type": "string", "example": "Intermitencia en el enlace residencial" }, "description": { "type": "string", "example": "El módem pierde sincronismo cada 15 minutos en horas de la tarde" }, "priority": { "type": "string", "example": "HIGH" } } }, "example": { "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "title": "Intermitencia en el enlace residencial", "description": "El módem pierde sincronismo cada 15 minutos en horas de la tarde", "priority": "HIGH" } } } } }, "delete": { "summary": "Eliminar caso de soporte", "description": "Permite realizar operaciones relacionadas con eliminar caso de soporte en el módulo Support Cases.", "tags": [ "Support Cases" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/surveys": { "get": { "summary": "Listar encuestas", "description": "Permite realizar operaciones relacionadas con listar encuestas en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear encuesta", "description": "Permite realizar operaciones relacionadas con crear encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } } }, "/api/surveys/{id}": { "get": { "summary": "Obtener encuesta por ID", "description": "Permite realizar operaciones relacionadas con obtener encuesta por id en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar encuesta", "description": "Permite realizar operaciones relacionadas con actualizar encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "delete": { "summary": "Eliminar encuesta", "description": "Permite realizar operaciones relacionadas con eliminar encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/surveys/{id}/questions": { "post": { "summary": "Crear questions de encuesta", "description": "Permite realizar operaciones relacionadas con crear questions de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } } }, "/api/surveys/{id}/questions/{questionId}": { "patch": { "summary": "Actualizar questions de encuesta", "description": "Permite realizar operaciones relacionadas con actualizar questions de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "questionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "delete": { "summary": "Eliminar questions de encuesta", "description": "Permite realizar operaciones relacionadas con eliminar questions de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "questionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/surveys/{id}/questions/{questionId}/options": { "post": { "summary": "Crear questions options de encuesta", "description": "Permite realizar operaciones relacionadas con crear questions options de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "questionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } } }, "/api/surveys/{id}/questions/{questionId}/options/{optionId}": { "patch": { "summary": "Actualizar questions options de encuesta", "description": "Permite realizar operaciones relacionadas con actualizar questions options de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "questionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "optionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "delete": { "summary": "Eliminar questions options de encuesta", "description": "Permite realizar operaciones relacionadas con eliminar questions options de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "questionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "optionId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/surveys/{id}/responses": { "post": { "summary": "Crear responses de encuesta", "description": "Permite realizar operaciones relacionadas con crear responses de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "get": { "summary": "Obtener responses de encuesta", "description": "Permite realizar operaciones relacionadas con obtener responses de encuesta en el módulo Surveys.", "tags": [ "Surveys" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Satisfacción de Enlace" }, "description": { "type": "string", "example": "Encuesta post-instalación de servicio de internet" }, "questions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Satisfacción de Enlace", "description": "Encuesta post-instalación de servicio de internet", "questions": [ { "text": "¿Cómo califica la velocidad?", "type": "rating", "required": true }, { "text": "Comentarios adicionales", "type": "text", "required": false } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/delivery/warehouses": { "get": { "summary": "Listar warehouses de entregas", "description": "Permite realizar operaciones relacionadas con listar warehouses de entregas en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear warehouses de entrega", "description": "Permite realizar operaciones relacionadas con crear warehouses de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/delivery/warehouses/{id}": { "get": { "summary": "Obtener warehouses de entrega", "description": "Permite realizar operaciones relacionadas con obtener warehouses de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar warehouses de entrega", "description": "Permite realizar operaciones relacionadas con actualizar warehouses de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "delete": { "summary": "Eliminar warehouses de entrega", "description": "Permite realizar operaciones relacionadas con eliminar warehouses de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/delivery/config": { "get": { "summary": "Listar config de entregas", "description": "Permite realizar operaciones relacionadas con listar config de entregas en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear config de entrega", "description": "Permite realizar operaciones relacionadas con crear config de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/delivery/zones": { "get": { "summary": "Listar zones de entregas", "description": "Permite realizar operaciones relacionadas con listar zones de entregas en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear zones de entrega", "description": "Permite realizar operaciones relacionadas con crear zones de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/delivery/zones/{id}": { "put": { "summary": "Actualizar zones de entrega", "description": "Permite realizar operaciones relacionadas con actualizar zones de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "delete": { "summary": "Eliminar zones de entrega", "description": "Permite realizar operaciones relacionadas con eliminar zones de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/delivery/drivers": { "get": { "summary": "Listar drivers de entregas", "description": "Permite realizar operaciones relacionadas con listar drivers de entregas en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear drivers de entrega", "description": "Permite realizar operaciones relacionadas con crear drivers de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/delivery/drivers/{id}": { "put": { "summary": "Actualizar drivers de entrega", "description": "Permite realizar operaciones relacionadas con actualizar drivers de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "delete": { "summary": "Eliminar drivers de entrega", "description": "Permite realizar operaciones relacionadas con eliminar drivers de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/delivery/check-location": { "post": { "summary": "Crear check location de entrega", "description": "Permite realizar operaciones relacionadas con crear check location de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/delivery/check-address": { "post": { "summary": "Crear check address de entrega", "description": "Permite realizar operaciones relacionadas con crear check address de entrega en el módulo Delivery.", "tags": [ "Delivery" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "address": { "type": "string", "example": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4" }, "city": { "type": "string", "example": "Caracas" }, "notes": { "type": "string", "example": "Entregar al agente de seguridad de turno" } } }, "example": { "checkoutId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "address": "Urbanización Las Mercedes, Calle Orinoco, Torre Dylema, Piso 4", "city": "Caracas", "notes": "Entregar al agente de seguridad de turno" } } } } } }, "/api/email-configs": { "get": { "summary": "Listar configuraciones de email", "description": "Permite realizar operaciones relacionadas con listar configuraciones de email en el módulo Email Configs.", "tags": [ "Email Configs" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear configuración de email", "description": "Permite realizar operaciones relacionadas con crear configuración de email en el módulo Email Configs.", "tags": [ "Email Configs" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "provider": { "type": "string", "example": "smtp" }, "host": { "type": "string", "example": "smtp.mailgun.org" }, "port": { "type": "number", "example": 587 }, "username": { "type": "string", "example": "postmaster@dylema.dev" }, "password": { "type": "string", "example": "smtp_secret_password_here" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "example": "smtp" }, "host": { "type": "string", "example": "smtp.mailgun.org" }, "port": { "type": "number", "example": 587 }, "username": { "type": "string", "example": "postmaster@dylema.dev" }, "password": { "type": "string", "example": "smtp_secret_password_here" } } }, "example": { "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } } } } } }, "/api/email-configs/event/{event}": { "get": { "summary": "Obtener event de configuración de email", "description": "Permite realizar operaciones relacionadas con obtener event de configuración de email en el módulo Email Configs.", "tags": [ "Email Configs" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "provider": { "type": "string", "example": "smtp" }, "host": { "type": "string", "example": "smtp.mailgun.org" }, "port": { "type": "number", "example": 587 }, "username": { "type": "string", "example": "postmaster@dylema.dev" }, "password": { "type": "string", "example": "smtp_secret_password_here" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "event", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/email-configs/check-domain/{domain}": { "get": { "summary": "Obtener check domain de configuración de email", "description": "Permite realizar operaciones relacionadas con obtener check domain de configuración de email en el módulo Email Configs.", "tags": [ "Email Configs" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "provider": { "type": "string", "example": "smtp" }, "host": { "type": "string", "example": "smtp.mailgun.org" }, "port": { "type": "number", "example": 587 }, "username": { "type": "string", "example": "postmaster@dylema.dev" }, "password": { "type": "string", "example": "smtp_secret_password_here" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/email-configs/config": { "get": { "summary": "Listar config de configuraciones de email", "description": "Permite realizar operaciones relacionadas con listar config de configuraciones de email en el módulo Email Configs.", "tags": [ "Email Configs" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "provider": "smtp", "host": "smtp.mailgun.org", "port": 587, "username": "postmaster@dylema.dev", "password": "smtp_secret_password_here" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaigns": { "get": { "summary": "Listar campañas", "description": "Permite realizar operaciones relacionadas con listar campañas en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear campaña", "description": "Permite realizar operaciones relacionadas con crear campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } } }, "/api/campaigns/{id}": { "get": { "summary": "Obtener campaña por ID", "description": "Permite realizar operaciones relacionadas con obtener campaña por id en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar campaña", "description": "Permite realizar operaciones relacionadas con actualizar campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "delete": { "summary": "Eliminar campaña", "description": "Permite realizar operaciones relacionadas con eliminar campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/campaigns/{id}/resolve-recipients": { "post": { "summary": "Crear resolve recipients de campaña", "description": "Permite realizar operaciones relacionadas con crear resolve recipients de campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } } }, "/api/campaigns/{id}/execute": { "post": { "summary": "Crear execute de campaña", "description": "Permite realizar operaciones relacionadas con crear execute de campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } } }, "/api/campaigns/{id}/pause": { "post": { "summary": "Crear pause de campaña", "description": "Permite realizar operaciones relacionadas con crear pause de campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } } }, "/api/campaigns/{id}/resume": { "post": { "summary": "Crear resume de campaña", "description": "Permite realizar operaciones relacionadas con crear resume de campaña en el módulo Campaigns.", "tags": [ "Campaigns" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Campaña de Renivelación de Saldos" }, "description": { "type": "string", "example": "Recordatorio de deudas pendientes a clientes" }, "campaignTemplateId": { "type": "string", "example": "b1a6cde2-98ee-44cc-a9fe-e91122334455" }, "scheduledAt": { "type": "string", "example": "2026-05-25T14:30:00Z" } } }, "example": { "name": "Campaña de Renivelación de Saldos", "description": "Recordatorio de deudas pendientes a clientes", "campaignTemplateId": "b1a6cde2-98ee-44cc-a9fe-e91122334455", "scheduledAt": "2026-05-25T14:30:00Z" } } } } } }, "/api/campaign-templates": { "get": { "summary": "Listar plantillas de campaña", "description": "Permite realizar operaciones relacionadas con listar plantillas de campaña en el módulo Campaign Templates.", "tags": [ "Campaign Templates" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear plantilla de campaña", "description": "Permite realizar operaciones relacionadas con crear plantilla de campaña en el módulo Campaign Templates.", "tags": [ "Campaign Templates" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plantilla Notificación SMS Vencimiento" }, "content": { "type": "string", "example": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD." }, "channel": { "type": "string", "example": "SMS" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plantilla Notificación SMS Vencimiento" }, "content": { "type": "string", "example": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD." }, "channel": { "type": "string", "example": "SMS" } } }, "example": { "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } } } } } }, "/api/campaign-templates/{id}": { "get": { "summary": "Obtener plantilla de campaña por ID", "description": "Permite realizar operaciones relacionadas con obtener plantilla de campaña por id en el módulo Campaign Templates.", "tags": [ "Campaign Templates" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plantilla Notificación SMS Vencimiento" }, "content": { "type": "string", "example": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD." }, "channel": { "type": "string", "example": "SMS" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar plantilla de campaña", "description": "Permite realizar operaciones relacionadas con actualizar plantilla de campaña en el módulo Campaign Templates.", "tags": [ "Campaign Templates" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Plantilla Notificación SMS Vencimiento" }, "content": { "type": "string", "example": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD." }, "channel": { "type": "string", "example": "SMS" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Plantilla Notificación SMS Vencimiento" }, "content": { "type": "string", "example": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD." }, "channel": { "type": "string", "example": "SMS" } } }, "example": { "name": "Plantilla Notificación SMS Vencimiento", "content": "Estimado cliente {firstName}, le recordamos su pago pendiente de {total} USD.", "channel": "SMS" } } } } }, "delete": { "summary": "Eliminar plantilla de campaña", "description": "Permite realizar operaciones relacionadas con eliminar plantilla de campaña en el módulo Campaign Templates.", "tags": [ "Campaign Templates" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/webhooks/emails/resend": { "post": { "summary": "Reenviar emails en webhook", "description": "Permite realizar operaciones relacionadas con reenviar emails en webhook en el módulo Webhooks.", "tags": [ "Webhooks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Pagos Recibidos" }, "url": { "type": "string", "example": "https://mi-sistema.com/webhooks/pagos" }, "events": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Pagos Recibidos", "url": "https://mi-sistema.com/webhooks/pagos", "events": [ "payment.approved", "payment.rejected" ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Pagos Recibidos" }, "url": { "type": "string", "example": "https://mi-sistema.com/webhooks/pagos" }, "events": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "Notificador de Pagos Recibidos", "url": "https://mi-sistema.com/webhooks/pagos", "events": [ "payment.approved", "payment.rejected" ] } } } } } }, "/api/webhooks/config": { "get": { "summary": "Listar config de webhooks", "description": "Permite realizar operaciones relacionadas con listar config de webhooks en el módulo Webhooks.", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Pagos Recibidos", "url": "https://mi-sistema.com/webhooks/pagos", "events": [ "payment.approved", "payment.rejected" ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/webhooks/elevenlabs/callbacks": { "post": { "summary": "Crear elevenlabs callbacks de webhook", "description": "Permite realizar operaciones relacionadas con crear elevenlabs callbacks de webhook en el módulo Webhooks.", "tags": [ "Webhooks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Pagos Recibidos" }, "url": { "type": "string", "example": "https://mi-sistema.com/webhooks/pagos" }, "events": { "type": "array", "items": { "type": "string" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Pagos Recibidos", "url": "https://mi-sistema.com/webhooks/pagos", "events": [ "payment.approved", "payment.rejected" ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Pagos Recibidos" }, "url": { "type": "string", "example": "https://mi-sistema.com/webhooks/pagos" }, "events": { "type": "array", "items": { "type": "string" } } } }, "example": { "name": "Notificador de Pagos Recibidos", "url": "https://mi-sistema.com/webhooks/pagos", "events": [ "payment.approved", "payment.rejected" ] } } } } } }, "/api/driver/status/online": { "patch": { "summary": "Actualizar status online de conductor", "description": "Permite realizar operaciones relacionadas con actualizar status online de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/status/busy": { "patch": { "summary": "Actualizar status busy de conductor", "description": "Permite realizar operaciones relacionadas con actualizar status busy de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/location": { "patch": { "summary": "Actualizar location de conductor", "description": "Permite realizar operaciones relacionadas con actualizar location de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/orders": { "get": { "summary": "Listar orders de conductores", "description": "Permite realizar operaciones relacionadas con listar orders de conductores en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/driver/orders/{id}/accept": { "patch": { "summary": "Actualizar orders accept de conductor", "description": "Permite realizar operaciones relacionadas con actualizar orders accept de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/orders/{id}/ship": { "patch": { "summary": "Actualizar orders ship de conductor", "description": "Permite realizar operaciones relacionadas con actualizar orders ship de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/orders/{id}/deliver": { "patch": { "summary": "Actualizar orders deliver de conductor", "description": "Permite realizar operaciones relacionadas con actualizar orders deliver de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/driver/stats": { "get": { "summary": "Listar stats de conductores", "description": "Permite realizar operaciones relacionadas con listar stats de conductores en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/driver/orders/{id}/status": { "patch": { "summary": "Actualizar orders status de conductor", "description": "Permite realizar operaciones relacionadas con actualizar orders status de conductor en el módulo Driver.", "tags": [ "Driver" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Carlos Rodríguez" }, "phone": { "type": "string", "example": "+584141112233" }, "licensePlate": { "type": "string", "example": "AE-123-XX" }, "vehicle": { "type": "string", "example": "Chevrolet Spark 2012" } } }, "example": { "name": "Carlos Rodríguez", "phone": "+584141112233", "licensePlate": "AE-123-XX", "vehicle": "Chevrolet Spark 2012" } } } } } }, "/api/queues/potential-agents": { "get": { "summary": "Listar potential agents de colas", "description": "Permite realizar operaciones relacionadas con listar potential agents de colas en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/queues": { "get": { "summary": "Listar colas", "description": "Permite realizar operaciones relacionadas con listar colas en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear cola", "description": "Permite realizar operaciones relacionadas con crear cola en el módulo Queues.", "tags": [ "Queues" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } } }, "/api/queues/{id}": { "get": { "summary": "Obtener cola por ID", "description": "Permite realizar operaciones relacionadas con obtener cola por id en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar cola", "description": "Permite realizar operaciones relacionadas con actualizar cola en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } }, "delete": { "summary": "Eliminar cola", "description": "Permite realizar operaciones relacionadas con eliminar cola en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/queues/{id}/members": { "post": { "summary": "Crear members de cola", "description": "Permite realizar operaciones relacionadas con crear members de cola en el módulo Queues.", "tags": [ "Queues" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Cola Ventas Fibra" }, "strategy": { "type": "string", "example": "least-recent" }, "timeout": { "type": "number", "example": 30 } } }, "example": { "name": "Cola Ventas Fibra", "strategy": "least-recent", "timeout": 30 } } } } } }, "/api/queues/{id}/members/{uniqueid}": { "delete": { "summary": "Eliminar members de cola", "description": "Permite realizar operaciones relacionadas con eliminar members de cola en el módulo Queues.", "tags": [ "Queues" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "uniqueid", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/asterisk-servers": { "get": { "summary": "Listar servidores Asterisk", "description": "Permite realizar operaciones relacionadas con listar servidores asterisk en el módulo Asterisk Servers.", "tags": [ "Asterisk Servers" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear servidor Asterisk", "description": "Permite realizar operaciones relacionadas con crear servidor asterisk en el módulo Asterisk Servers.", "tags": [ "Asterisk Servers" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "PBX Principal Caracas" }, "host": { "type": "string", "example": "pbx.dylema.dev" }, "port": { "type": "number", "example": 5060 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "PBX Principal Caracas" }, "host": { "type": "string", "example": "pbx.dylema.dev" }, "port": { "type": "number", "example": 5060 } } }, "example": { "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } } } } } }, "/api/asterisk-servers/{id}": { "get": { "summary": "Obtener servidor Asterisk por ID", "description": "Permite realizar operaciones relacionadas con obtener servidor asterisk por id en el módulo Asterisk Servers.", "tags": [ "Asterisk Servers" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "PBX Principal Caracas" }, "host": { "type": "string", "example": "pbx.dylema.dev" }, "port": { "type": "number", "example": 5060 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar servidor Asterisk", "description": "Permite realizar operaciones relacionadas con actualizar servidor asterisk en el módulo Asterisk Servers.", "tags": [ "Asterisk Servers" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "PBX Principal Caracas" }, "host": { "type": "string", "example": "pbx.dylema.dev" }, "port": { "type": "number", "example": 5060 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "PBX Principal Caracas" }, "host": { "type": "string", "example": "pbx.dylema.dev" }, "port": { "type": "number", "example": 5060 } } }, "example": { "name": "PBX Principal Caracas", "host": "pbx.dylema.dev", "port": 5060 } } } } }, "delete": { "summary": "Eliminar servidor Asterisk", "description": "Permite realizar operaciones relacionadas con eliminar servidor asterisk en el módulo Asterisk Servers.", "tags": [ "Asterisk Servers" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/user-statuses": { "get": { "summary": "Listar estados de usuario", "description": "Permite realizar operaciones relacionadas con listar estados de usuario en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "En Almuerzo", "color": "#FFA500" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear estado de usuario", "description": "Permite realizar operaciones relacionadas con crear estado de usuario en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "En Almuerzo", "color": "#FFA500" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "name": "En Almuerzo", "color": "#FFA500" } } } } } }, "/api/user-statuses/{id}": { "get": { "summary": "Obtener estado de usuario por ID", "description": "Permite realizar operaciones relacionadas con obtener estado de usuario por id en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "En Almuerzo", "color": "#FFA500" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar estado de usuario", "description": "Permite realizar operaciones relacionadas con actualizar estado de usuario en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "En Almuerzo", "color": "#FFA500" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "name": "En Almuerzo", "color": "#FFA500" } } } } }, "delete": { "summary": "Eliminar estado de usuario", "description": "Permite realizar operaciones relacionadas con eliminar estado de usuario en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/user-statuses/set": { "post": { "summary": "Crear set de estado de usuario", "description": "Permite realizar operaciones relacionadas con crear set de estado de usuario en el módulo User Statuses.", "tags": [ "User Statuses" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "En Almuerzo", "color": "#FFA500" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "En Almuerzo" }, "color": { "type": "string", "example": "#FFA500" } } }, "example": { "name": "En Almuerzo", "color": "#FFA500" } } } } } }, "/api/storage/local-upload": { "put": { "summary": "Subir archivo de almacenamiento", "description": "Permite realizar operaciones relacionadas con subir archivo de almacenamiento en el módulo Storage.", "tags": [ "Storage" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "key": { "type": "string", "example": "contratos/contrato_123.pdf" }, "bucket": { "type": "string", "example": "dylema-customer-contracts" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "key": "contratos/contrato_123.pdf", "bucket": "dylema-customer-contracts" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "example": "contratos/contrato_123.pdf" }, "bucket": { "type": "string", "example": "dylema-customer-contracts" } } }, "example": { "key": "contratos/contrato_123.pdf", "bucket": "dylema-customer-contracts" } } } } } }, "/api/agent/webhook/{channelId}": { "get": { "summary": "Obtener webhook de agente", "description": "Permite realizar operaciones relacionadas con obtener webhook de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "post": { "summary": "Crear webhook de agente", "description": "Permite realizar operaciones relacionadas con crear webhook de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } } }, "/api/agent/channels": { "get": { "summary": "Listar channels de agentes", "description": "Permite realizar operaciones relacionadas con listar channels de agentes en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear channels de agente", "description": "Permite realizar operaciones relacionadas con crear channels de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } } }, "/api/agent/channels/{id}": { "get": { "summary": "Obtener channels de agente", "description": "Permite realizar operaciones relacionadas con obtener channels de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar channels de agente", "description": "Permite realizar operaciones relacionadas con actualizar channels de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "delete": { "summary": "Eliminar channels de agente", "description": "Permite realizar operaciones relacionadas con eliminar channels de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/agent/conversations/{id}": { "get": { "summary": "Obtener conversations de agente", "description": "Permite realizar operaciones relacionadas con obtener conversations de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/agent/conversations": { "get": { "summary": "Listar conversations de agentes", "description": "Permite realizar operaciones relacionadas con listar conversations de agentes en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/agent/conversations/{id}/messages": { "get": { "summary": "Obtener conversations messages de agente", "description": "Permite realizar operaciones relacionadas con obtener conversations messages de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/agent/conversations/{id}/resolve": { "patch": { "summary": "Actualizar conversations resolve de agente", "description": "Permite realizar operaciones relacionadas con actualizar conversations resolve de agente en el módulo Agent.", "tags": [ "Agent" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44" }, "queueId": { "type": "string", "example": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } }, "example": { "userId": "c3b8a6cd-9430-4eeb-b639-68ea9f135b44", "queueId": "d9b8e6ca-94cd-4eeb-a8ff-69ea11223344" } } } } } }, "/api/payment-methods": { "get": { "summary": "Listar métodos de pago", "description": "Permite realizar operaciones relacionadas con listar métodos de pago en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear método de pago", "description": "Permite realizar operaciones relacionadas con crear método de pago en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } } }, "/api/payment-methods/{id}": { "get": { "summary": "Obtener método de pago por ID", "description": "Permite realizar operaciones relacionadas con obtener método de pago por id en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar método de pago", "description": "Permite realizar operaciones relacionadas con actualizar método de pago en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } }, "delete": { "summary": "Eliminar método de pago", "description": "Permite realizar operaciones relacionadas con eliminar método de pago en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/payment-methods/{id}/toggle": { "patch": { "summary": "Alternar de método de pago", "description": "Permite realizar operaciones relacionadas con alternar de método de pago en el módulo Payment Methods.", "tags": [ "Payment Methods" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Pago Móvil Mercantil" }, "provider": { "type": "string", "example": "pago-movil" }, "config": { "type": "object", "properties": { "phone": { "type": "string", "example": "+584121234567" }, "rif": { "type": "string", "example": "J-12345678-0" } } } } }, "example": { "name": "Pago Móvil Mercantil", "provider": "pago-movil", "config": { "phone": "+584121234567", "rif": "J-12345678-0" } } } } } } }, "/api/custom-fields/definitions": { "get": { "summary": "Listar definitions de campos personalizados", "description": "Permite realizar operaciones relacionadas con listar definitions de campos personalizados en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear definitions de campo personalizado", "description": "Permite realizar operaciones relacionadas con crear definitions de campo personalizado en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } } }, "/api/custom-fields/definitions/{id}": { "patch": { "summary": "Actualizar definitions de campo personalizado", "description": "Permite realizar operaciones relacionadas con actualizar definitions de campo personalizado en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } }, "delete": { "summary": "Eliminar definitions de campo personalizado", "description": "Permite realizar operaciones relacionadas con eliminar definitions de campo personalizado en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/custom-fields/values/{entityId}": { "get": { "summary": "Obtener values de campo personalizado", "description": "Permite realizar operaciones relacionadas con obtener values de campo personalizado en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "entityId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "post": { "summary": "Crear values de campo personalizado", "description": "Permite realizar operaciones relacionadas con crear values de campo personalizado en el módulo Custom Fields.", "tags": [ "Custom Fields" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "entityId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Nivel de Fibra (dBm)" }, "type": { "type": "string", "example": "number" }, "entity": { "type": "string", "example": "customer" } } }, "example": { "name": "Nivel de Fibra (dBm)", "type": "number", "entity": "customer" } } } } } }, "/api/tasks/projects": { "get": { "summary": "Listar projects de tareas", "description": "Permite realizar operaciones relacionadas con listar projects de tareas en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear projects de tarea", "description": "Permite realizar operaciones relacionadas con crear projects de tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } } }, "/api/tasks/projects/{id}": { "get": { "summary": "Obtener projects de tarea", "description": "Permite realizar operaciones relacionadas con obtener projects de tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "patch": { "summary": "Actualizar projects de tarea", "description": "Permite realizar operaciones relacionadas con actualizar projects de tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } } }, "/api/tasks": { "get": { "summary": "Listar tareas", "description": "Permite realizar operaciones relacionadas con listar tareas en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear tarea", "description": "Permite realizar operaciones relacionadas con crear tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } } }, "/api/tasks/{id}": { "patch": { "summary": "Actualizar tarea", "description": "Permite realizar operaciones relacionadas con actualizar tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "delete": { "summary": "Eliminar tarea", "description": "Permite realizar operaciones relacionadas con eliminar tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/tasks/{id}/move": { "post": { "summary": "Crear move de tarea", "description": "Permite realizar operaciones relacionadas con crear move de tarea en el módulo Tasks.", "tags": [ "Tasks" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Visita técnica por módem dañado" }, "description": { "type": "string", "example": "Realizar cambio de ONT y validar niveles de potencia óptica" }, "customerId": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "dueDate": { "type": "string", "example": "2026-05-20T16:00:00Z" } } }, "example": { "title": "Visita técnica por módem dañado", "description": "Realizar cambio de ONT y validar niveles de potencia óptica", "customerId": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "dueDate": "2026-05-20T16:00:00Z" } } } } } }, "/api/analytics/datalakes/mapped": { "get": { "summary": "Listar datalakes mapped de analíticas", "description": "Permite realizar operaciones relacionadas con listar datalakes mapped de analíticas en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/analytics/datalakes": { "get": { "summary": "Listar datalakes de analíticas", "description": "Permite realizar operaciones relacionadas con listar datalakes de analíticas en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear datalakes de analítica", "description": "Permite realizar operaciones relacionadas con crear datalakes de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/datalakes/{id}": { "get": { "summary": "Obtener datalakes de analítica", "description": "Permite realizar operaciones relacionadas con obtener datalakes de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar datalakes de analítica", "description": "Permite realizar operaciones relacionadas con actualizar datalakes de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } }, "delete": { "summary": "Eliminar datalakes de analítica", "description": "Permite realizar operaciones relacionadas con eliminar datalakes de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/analytics/data-sources": { "get": { "summary": "Listar data sources de analíticas", "description": "Permite realizar operaciones relacionadas con listar data sources de analíticas en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear data sources de analítica", "description": "Permite realizar operaciones relacionadas con crear data sources de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/data-sources/{id}": { "get": { "summary": "Obtener data sources de analítica", "description": "Permite realizar operaciones relacionadas con obtener data sources de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar data sources de analítica", "description": "Permite realizar operaciones relacionadas con actualizar data sources de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } }, "delete": { "summary": "Eliminar data sources de analítica", "description": "Permite realizar operaciones relacionadas con eliminar data sources de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/analytics/datalakes/{id}/mapping-preview": { "post": { "summary": "Crear datalakes mapping preview de analítica", "description": "Permite realizar operaciones relacionadas con crear datalakes mapping preview de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/datalakes/{id}/mapping-test": { "post": { "summary": "Crear datalakes mapping test de analítica", "description": "Permite realizar operaciones relacionadas con crear datalakes mapping test de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/query": { "post": { "summary": "Consultar en analítica", "description": "Permite realizar operaciones relacionadas con consultar en analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/configs": { "get": { "summary": "Listar configs de analíticas", "description": "Permite realizar operaciones relacionadas con listar configs de analíticas en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear configs de analítica", "description": "Permite realizar operaciones relacionadas con crear configs de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/configs/{id}": { "get": { "summary": "Obtener configs de analítica", "description": "Permite realizar operaciones relacionadas con obtener configs de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar configs de analítica", "description": "Permite realizar operaciones relacionadas con actualizar configs de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } }, "delete": { "summary": "Eliminar configs de analítica", "description": "Permite realizar operaciones relacionadas con eliminar configs de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/analytics/configs/{id}/execute": { "post": { "summary": "Crear configs execute de analítica", "description": "Permite realizar operaciones relacionadas con crear configs execute de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/configs/{id}/widgets": { "get": { "summary": "Obtener configs widgets de analítica", "description": "Permite realizar operaciones relacionadas con obtener configs widgets de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "post": { "summary": "Crear configs widgets de analítica", "description": "Permite realizar operaciones relacionadas con crear configs widgets de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } } }, "/api/analytics/configs/widgets/{widgetId}": { "put": { "summary": "Actualizar configs widgets de analítica", "description": "Permite realizar operaciones relacionadas con actualizar configs widgets de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "metric": "sales_total_daily", "value": 4500 } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "widgetId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metric": { "type": "string", "example": "sales_total_daily" }, "value": { "type": "number", "example": 4500 } } }, "example": { "metric": "sales_total_daily", "value": 4500 } } } } }, "delete": { "summary": "Eliminar configs widgets de analítica", "description": "Permite realizar operaciones relacionadas con eliminar configs widgets de analítica en el módulo Analytics.", "tags": [ "Analytics" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "widgetId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/dashboards/definitions": { "get": { "summary": "Listar definitions de tableros de control", "description": "Permite realizar operaciones relacionadas con listar definitions de tableros de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear definitions de tablero de control", "description": "Permite realizar operaciones relacionadas con crear definitions de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } } }, "/api/dashboards/definitions/{id}": { "get": { "summary": "Obtener definitions de tablero de control", "description": "Permite realizar operaciones relacionadas con obtener definitions de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar definitions de tablero de control", "description": "Permite realizar operaciones relacionadas con actualizar definitions de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "delete": { "summary": "Eliminar definitions de tablero de control", "description": "Permite realizar operaciones relacionadas con eliminar definitions de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/dashboards/list": { "get": { "summary": "Listar list de tableros de control", "description": "Permite realizar operaciones relacionadas con listar list de tableros de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/dashboards": { "get": { "summary": "Listar tableros de control", "description": "Permite realizar operaciones relacionadas con listar tableros de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear tablero de control", "description": "Permite realizar operaciones relacionadas con crear tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } } }, "/api/dashboards/order": { "put": { "summary": "Actualizar order de tablero de control", "description": "Permite realizar operaciones relacionadas con actualizar order de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } } }, "/api/dashboards/{id}": { "put": { "summary": "Actualizar tablero de control", "description": "Permite realizar operaciones relacionadas con actualizar tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "delete": { "summary": "Eliminar tablero de control", "description": "Permite realizar operaciones relacionadas con eliminar tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/dashboards/{id}/configs": { "post": { "summary": "Crear configs de tablero de control", "description": "Permite realizar operaciones relacionadas con crear configs de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } } }, "/api/dashboards/{id}/configs/order": { "put": { "summary": "Actualizar configs order de tablero de control", "description": "Permite realizar operaciones relacionadas con actualizar configs order de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } } }, "/api/dashboards/{id}/configs/{configId}": { "delete": { "summary": "Eliminar configs de tablero de control", "description": "Permite realizar operaciones relacionadas con eliminar configs de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "configId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/dashboards/results/{merchantAnalyticConfigId}": { "get": { "summary": "Obtener results de tablero de control", "description": "Permite realizar operaciones relacionadas con obtener results de tablero de control en el módulo Dashboards.", "tags": [ "Dashboards" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Monitoreo Técnico" }, "layout": { "type": "object", "properties": { "rows": { "type": "number", "example": 3 }, "cols": { "type": "number", "example": 4 } } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Monitoreo Técnico", "layout": { "rows": 3, "cols": 4 } } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "merchantAnalyticConfigId", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/attachments/entity/{type}/{id}": { "get": { "summary": "Obtener entity de archivo adjunto", "description": "Permite realizar operaciones relacionadas con obtener entity de archivo adjunto en el módulo Attachments.", "tags": [ "Attachments" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "filename": { "type": "string", "example": "cedula_identidad.pdf" }, "url": { "type": "string", "example": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "filename": "cedula_identidad.pdf", "url": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/attachments": { "post": { "summary": "Crear archivo adjunto", "description": "Permite realizar operaciones relacionadas con crear archivo adjunto en el módulo Attachments.", "tags": [ "Attachments" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "filename": { "type": "string", "example": "cedula_identidad.pdf" }, "url": { "type": "string", "example": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "filename": "cedula_identidad.pdf", "url": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filename": { "type": "string", "example": "cedula_identidad.pdf" }, "url": { "type": "string", "example": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } }, "example": { "filename": "cedula_identidad.pdf", "url": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } } } } }, "/api/attachments/{id}/download": { "get": { "summary": "Obtener download de archivo adjunto", "description": "Permite realizar operaciones relacionadas con obtener download de archivo adjunto en el módulo Attachments.", "tags": [ "Attachments" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "filename": { "type": "string", "example": "cedula_identidad.pdf" }, "url": { "type": "string", "example": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "filename": "cedula_identidad.pdf", "url": "https://storage.dylema.dev/uploads/cedula_identidad.pdf" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/attachments/{id}": { "delete": { "summary": "Eliminar archivo adjunto", "description": "Permite realizar operaciones relacionadas con eliminar archivo adjunto en el módulo Attachments.", "tags": [ "Attachments" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/automation/webhook/{id}": { "post": { "summary": "Crear webhook de automatización", "description": "Permite realizar operaciones relacionadas con crear webhook de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/auth-configs": { "get": { "summary": "Listar auth configs de automatizaciones", "description": "Permite realizar operaciones relacionadas con listar auth configs de automatizaciones en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear auth configs de automatización", "description": "Permite realizar operaciones relacionadas con crear auth configs de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/auth-configs/{id}/authorize": { "get": { "summary": "Obtener auth configs authorize de automatización", "description": "Permite realizar operaciones relacionadas con obtener auth configs authorize de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/automation/auth-configs/callback": { "post": { "summary": "Crear auth configs callback de automatización", "description": "Permite realizar operaciones relacionadas con crear auth configs callback de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/auth-configs/{id}": { "delete": { "summary": "Eliminar auth configs de automatización", "description": "Permite realizar operaciones relacionadas con eliminar auth configs de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar auth configs de automatización", "description": "Permite realizar operaciones relacionadas con actualizar auth configs de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation": { "get": { "summary": "Listar automatizaciones", "description": "Permite realizar operaciones relacionadas con listar automatizaciones en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "summary": "Crear automatización", "description": "Permite realizar operaciones relacionadas con crear automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/runs": { "get": { "summary": "Listar runs de automatizaciones", "description": "Permite realizar operaciones relacionadas con listar runs de automatizaciones en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Lista de registros recuperada correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "nextCursor": { "type": "string", "example": "2026-05-17T20:33:00.000Z" } } }, "example": { "data": [ { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } ], "nextCursor": "2026-05-17T20:33:00.000Z" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/automation/runs/{id}": { "get": { "summary": "Obtener runs de automatización", "description": "Permite realizar operaciones relacionadas con obtener runs de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/automation/runs/{id}/results": { "get": { "summary": "Obtener runs results de automatización", "description": "Permite realizar operaciones relacionadas con obtener runs results de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/automation/{id}": { "get": { "summary": "Obtener automatización por ID", "description": "Permite realizar operaciones relacionadas con obtener automatización por id en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Detalles del registro recuperados correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] }, "put": { "summary": "Actualizar automatización", "description": "Permite realizar operaciones relacionadas con actualizar automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "delete": { "summary": "Eliminar automatización", "description": "Permite realizar operaciones relacionadas con eliminar automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Eliminado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Deleted successfully" } } }, "example": { "message": "Deleted successfully" } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ] } }, "/api/automation/{id}/steps": { "put": { "summary": "Actualizar pasos de automatización", "description": "Permite realizar operaciones relacionadas con actualizar pasos de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "200": { "description": "Actualizado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/{id}/trigger": { "post": { "summary": "Crear trigger de automatización", "description": "Permite realizar operaciones relacionadas con crear trigger de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador de recurso", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } }, "/api/automation/test-request": { "post": { "summary": "Crear test request de automatización", "description": "Permite realizar operaciones relacionadas con crear test request de automatización en el módulo Automation.", "tags": [ "Automation" ], "responses": { "201": { "description": "Creado correctamente", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259" }, "createdAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "updatedAt": { "type": "string", "example": "2026-05-17T20:33:00.000Z" }, "merchantId": { "type": "string", "example": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d" }, "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "id": "8f8b88cc-5b12-42bb-92dd-a99f36f4d259", "createdAt": "2026-05-17T20:33:00.000Z", "updatedAt": "2026-05-17T20:33:00.000Z", "merchantId": "7e3b88dd-92ff-4cbb-a9ee-d345f4bb599d", "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Notificador de Vencimiento de Factura" }, "trigger": { "type": "string", "example": "invoice.unpaid" }, "actions": { "type": "array", "items": { "type": "object" } } } }, "example": { "name": "Notificador de Vencimiento de Factura", "trigger": "invoice.unpaid", "actions": [ { "type": "email", "templateId": "notif-venc" }, { "type": "sms", "templateId": "notif-sms" } ] } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }