Docs orders

docs/sim-api/Activate.bru

@@ -6,16 +6,80 @@ meta {
 
 post {
   url: {{baseurl}}/sim/activate
-  body: formUrlEncoded
+  body: json
   auth: inherit
 }
 
+body:json {
+  {
+    "iccid": "1234"
+  }
+}
+
 body:form-urlencoded {
-  iccid: 8933201125065156057
-  offer: SAVEFAMILY1
+  iccid: 123
+  offer: mensual
 }
 
 settings {
   encodeUrl: true
   timeout: 0
 }
+
+docs {
+  Campos de entrada: 
+  ```ts
+  // Header requerido
+  // > content-type:application/x-www-form-urlencoded
+  // > content-type:application/json
+  // Cualquiera de los 2 es valido
+  
+  // Esquema body
+  {
+    iccid: string,
+    offer: "mensual" | "anual" | "SAVEFAMILY1" | "SAVEFAMILY2"
+    webhook?: string,
+  }
+  ```
+  
+  En el campo `offer` "mensual" equivale a "SAVEFAMILY2" y "anual" a "SAVEFAMILY1" porque se mantien los códigos de Oferta de Objenious por compatibilidad pero se espera usar "mensual" y "anual" y hacer la conversión en el servicio de cada proveedor.
+  
+  Para las llamadas al webhook se va a usar siempre el metodo `POST`, ahora mismo no se firman los mensajes. Se introduce la URL completa tal que `https://dominion.com/v1/endpoint`.
+  
+  Respuestas:
+  - **200**: OK 
+  ``` ts
+  // Esquema
+  {
+    iccid: string,
+    operation: string,
+    message_id: string, //uuidv7
+  }
+  ```
+  ``` json
+  // Ejemplo
+  {
+    "iccid": "89332011250651xxxxx",
+    "operation": "activation",
+    "message_id": "019dbeaf-8abb-7783-8b51-94fbd9f0b0df"
+  }
+  ```
+  
+  *iccid*: Confirmación del iccid enviado.
+  *operation*: Confirmación de la operacion que se ha aplicado.
+  *message_id*: Id de la operación, para consultar en orders.
+  
+  > A futuro se va a incluir un campo `"ref":[]` para añadir los enlaces a las consultas de la operación. El body va a permitir tambien json.
+  
+  - **402**: Algún campo es incorrecto
+  Se indica que campo es incorrecto, si hubiese mas de uno solo aparecería el primero en comprobarse.
+  ```json
+    "errors": {
+      "msg": "La longitud del iccid es incorrecta debera ser de 19 caracteres",
+      "field": "iccid"
+    }
+  ```
+  
+  - **500**: Error general
+  Ha ocurrido un error imprevisto durante la 
+}

docs/sim-api/Activation Email.bru

@@ -1,7 +1,7 @@
 meta {
   name: Activation Email
   type: http
-  seq: 6
+  seq: 7
 }
 
 post {

docs/sim-api/Cancel.bru

@@ -1,7 +1,7 @@
 meta {
   name: Cancel
   type: http
-  seq: 1
+  seq: 3
 }
 
 post {

docs/sim-api/Docs.bru

@@ -1,7 +1,7 @@
 meta {
   name: Docs
   type: http
-  seq: 12
+  seq: 10
 }
 
 get {

docs/sim-api/Health.bru

@@ -1,7 +1,7 @@
 meta {
   name: Health
   type: http
-  seq: 5
+  seq: 6
 }
 
 get {

docs/sim-api/Orders/Get pending orders.bru

@@ -1,7 +1,7 @@
 meta {
   name: Get pending orders
   type: http
-  seq: 11
+  seq: 10
 }
 
 get {

docs/sim-api/Orders/Order by id.bru

@@ -5,7 +5,7 @@ meta {
 }
 
 get {
-  url: {{baseurl}}/orders/
+  url: {{baseurl}}/orders/019dbeaf-8abb-7783-8b51-94fbd9f0b0df
   body: none
   auth: inherit
 }

docs/sim-api/Orders/Orders by message_id.bru

@@ -5,15 +5,11 @@ meta {
 }
 
 get {
-  url: {{baseurl}}/orders/message_id/019c93d3-014a-711d-b958-03dd629be78d
+  url: {{baseurl}}/orders/message_id/019dbeaf-8abb-7783-8b51-94fbd9f0b0df
   body: none
   auth: inherit
 }
 
-params:query {
-  ~message_id: 019c93d3-014a-711d-b958-03dd629be78d
-}
-
 settings {
   encodeUrl: true
   timeout: 0

docs/sim-api/Orders/folder.bru

@@ -0,0 +1,44 @@
+meta {
+  name: Orders
+}
+
+auth {
+  mode: inherit
+}
+
+docs {
+  # Orders
+  
+  Los *order* representan ordenes que se hacen al servidor y representan en que estado se encuentran las peticiones. Los *order* se generan cuando se solicita una operacion y devuelven su identificador en el campo `message_id` de todas las respuestas a peticiones que requieran cambios. Los identificadores de `order` son UUIDv7, aunque tambien tienen asociado un id tradicional BIGINT en la BDD.
+  
+  ## Ciclo de vida
+  
+  Cuando se crea un *order* comienza en estado `pending`, inicando que ha entrado en la cola y está pendiente de iniciarse; una vez se ha consumido por un servicio pasa a estado `running` indicando que la operacion asociada al *order* ha comenzado, el order continuara en este estado durante un tiempo indefinido (pueden pasar semanas para algunos casos), hasta que la tara finalize correctamente o con errores. En el caso que la tarea finalize con éxito el *order* pasará a estado `finished`, en caso de que haya habido un error el estado será `failed` y se almacenará el error en los campos `error_message` y opcionalemente en `error_stacktrace` según gravedad del error.
+  
+  - Caso normal
+  `pending` -> `running` -> `finished`
+  
+  - Error durante el consumo
+  `pending` -> `failed`
+  
+  - Error durante la operacion
+  `pending` -> `running` -> `failed`
+  
+  ## Endpoints 
+  Estan sujetos a cambios en cuanto a mostrar información
+  
+  - [WIP]**GET** /orders?{query} 
+  Devuelve todos los orders con un campo que tenga el valor especificado en la query
+  
+  - **GET** /orders/{id}
+  Devuelve el order objetivo según su UUID de mensaje (No según el uuid de mensaje)
+   
+  - **GET** /orders/base_id/{id}
+  Devuelve el id según su id de la bdd, no es el metodo normal de usar la api
+  
+  - **GET** /orders/pending
+  Devuelve todas las order que no hayan finalizado
+  
+  
+  
+}

docs/sim-api/Pause.bru

@@ -1,7 +1,7 @@
 meta {
   name: Pause
   type: http
-  seq: 1
+  seq: 4
 }
 
 post {

docs/sim-api/Preactivate.bru

@@ -1,7 +1,7 @@
 meta {
   name: Preactivate
   type: http
-  seq: 1
+  seq: 5
 }
 
 post {

docs/sim-api/ReActivate.bru

@@ -1,7 +1,7 @@
 meta {
   name: ReActivate
   type: http
-  seq: 13
+  seq: 11
 }
 
 post {

docs/sim-api/collection.bru

@@ -1,5 +1,6 @@
 docs {
-  Los endpoint tienen unos campos comunes de entrada:
+  Todos los endpoint tienen unos campos comunes de entrada:
+
   ```ts
   {
     iccid: string,

docs/sim-api/test proxy.bru

@@ -1,7 +1,7 @@
 meta {
   name: test proxy
   type: http
-  seq: 14
+  seq: 12
 }
 
 get {