@wevion/cli 1.0.3946 → 1.0.3957

package/openapi.json

@@ -590,6 +590,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "responses": {
@@ -696,6 +699,32 @@
               }
             }
           },
+          "403": {
+            "description": "Forbidden - caller lacks the required role/permission",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "statusCode",
+                    "error",
+                    "message"
+                  ],
+                  "properties": {
+                    "statusCode": {
+                      "type": "number"
+                    },
+                    "error": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "422": {
             "description": "Unprocessable entity - semantic validation failed",
             "content": {
@@ -722,6 +751,16 @@
               }
             }
           },
+          "429": {
+            "description": "Too many requests - rate limit exceeded. Reachable on every API-key operation: the per-key cap sold with the plan answers `code: API_KEY_RATE_LIMITED` with `retry_after_seconds` and the `Retry-After` header. The global per-IP limiter can answer here too, with the same status and only `statusCode`, `error` and `message`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitedResponse"
+                }
+              }
+            }
+          },
           "500": {
             "description": "Internal server error",
             "content": {
@@ -862,6 +901,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "responses": {
@@ -968,6 +1010,32 @@
               }
             }
           },
+          "403": {
+            "description": "Forbidden - caller lacks the required role/permission",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "statusCode",
+                    "error",
+                    "message"
+                  ],
+                  "properties": {
+                    "statusCode": {
+                      "type": "number"
+                    },
+                    "error": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "422": {
             "description": "Unprocessable entity - semantic validation failed",
             "content": {
@@ -994,6 +1062,16 @@
               }
             }
           },
+          "429": {
+            "description": "Too many requests - rate limit exceeded. Reachable on every API-key operation: the per-key cap sold with the plan answers `code: API_KEY_RATE_LIMITED` with `retry_after_seconds` and the `Retry-After` header. The global per-IP limiter can answer here too, with the same status and only `statusCode`, `error` and `message`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitedResponse"
+                }
+              }
+            }
+          },
           "500": {
             "description": "Internal server error",
             "content": {
@@ -201276,7 +201354,7 @@
         "tags": [
           "profitability"
         ],
-        "description": "Scans enabled profitability configurations and returns campaign-level margin alerts below each configured threshold.",
+        "description": "Scans the accessible sessions' profitability configurations, whether or not the margin alert is switched on, and returns campaign-level margins below each configured threshold. Each row states whether its revenue is tracked or estimated.",
         "security": [
           {
             "bearerAuth": []
@@ -201306,8 +201384,11 @@
                           "external_campaign_id",
                           "lookback_days",
                           "platform",
+                          "revenue_net_total",
                           "severity",
-                          "threshold"
+                          "spend_total",
+                          "threshold",
+                          "tracked_revenue"
                         ],
                         "properties": {
                           "avg_margin": {
@@ -201332,6 +201413,10 @@
                           "platform": {
                             "type": "string"
                           },
+                          "revenue_net_total": {
+                            "description": "Net revenue over the lookback window, in the session base currency.",
+                            "type": "number"
+                          },
                           "severity": {
                             "anyOf": [
                               {
@@ -201348,8 +201433,16 @@
                               }
                             ]
                           },
+                          "spend_total": {
+                            "description": "Ad spend over the lookback window, in the session base currency.",
+                            "type": "number"
+                          },
                           "threshold": {
                             "type": "number"
+                          },
+                          "tracked_revenue": {
+                            "description": "True when every day in the window has revenue from a tracked source (Shopify, WooCommerce, tracker). False means the margin is estimated from the ad platform conversion value.",
+                            "type": "boolean"
                           }
                         }
                       }
@@ -202745,7 +202838,7 @@
         "tags": [
           "profitability"
         ],
-        "description": "Returns the profitability defaults and alert settings for the first accessible session, creating defaults when needed.",
+        "description": "Returns the profitability defaults and alert settings for the first accessible session, creating defaults when needed. margin_alert_available says whether the margin alert can be switched on.",
         "security": [
           {
             "bearerAuth": []
@@ -202767,7 +202860,8 @@
                     "margin_alert_threshold",
                     "margin_alert_enabled",
                     "margin_alert_lookback_days",
-                    "keitaro_sku_field"
+                    "keitaro_sku_field",
+                    "margin_alert_available"
                   ],
                   "properties": {
                     "default_cogs_pct": {
@@ -202816,6 +202910,10 @@
                           "type": "null"
                         }
                       ]
+                    },
+                    "margin_alert_available": {
+                      "description": "True when a tracked revenue source (Shopify, WooCommerce or a tracker) is connected and active. The margin alert can be switched on only when true.",
+                      "type": "boolean"
                     }
                   }
                 }
@@ -202884,7 +202982,7 @@
         "tags": [
           "profitability"
         ],
-        "description": "Updates profitability defaults and alert settings for the first accessible session, then schedules recent rematerialization.",
+        "description": "Updates profitability defaults and alert settings for the first accessible session, then schedules recent rematerialization. Switching the margin alert on is refused with 422 MARGIN_ALERT_REQUIRES_TRACKED_REVENUE when no tracked revenue source (Shopify, WooCommerce or a tracker) is connected.",
         "requestBody": {
           "required": true,
           "content": {
@@ -202965,7 +203063,8 @@
                     "margin_alert_threshold",
                     "margin_alert_enabled",
                     "margin_alert_lookback_days",
-                    "keitaro_sku_field"
+                    "keitaro_sku_field",
+                    "margin_alert_available"
                   ],
                   "properties": {
                     "default_cogs_pct": {
@@ -203014,6 +203113,10 @@
                           "type": "null"
                         }
                       ]
+                    },
+                    "margin_alert_available": {
+                      "description": "True when a tracked revenue source (Shopify, WooCommerce or a tracker) is connected and active. The margin alert can be switched on only when true.",
+                      "type": "boolean"
                     }
                   }
                 }
@@ -203030,6 +203133,32 @@
               }
             }
           },
+          "422": {
+            "description": "Unprocessable entity - semantic validation failed",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "statusCode",
+                    "error",
+                    "message"
+                  ],
+                  "properties": {
+                    "statusCode": {
+                      "type": "number"
+                    },
+                    "error": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "500": {
             "description": "Internal server error",
             "content": {
@@ -203921,6 +204050,7 @@
                           "break_even_roas",
                           "data_source",
                           "data_quality",
+                          "tracked_revenue",
                           "currency"
                         ],
                         "properties": {
@@ -204078,6 +204208,10 @@
                           "data_quality": {
                             "type": "string"
                           },
+                          "tracked_revenue": {
+                            "description": "True when every day with revenue in the row has revenue from a tracked source (Shopify, WooCommerce, tracker). False means the margin is estimated from the ad platform conversion value.",
+                            "type": "boolean"
+                          },
                           "currency": {
                             "type": "string"
                           }
@@ -393671,6 +393805,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "responses": {
@@ -393777,6 +393914,32 @@
               }
             }
           },
+          "403": {
+            "description": "Forbidden - caller lacks the required role/permission",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "statusCode",
+                    "error",
+                    "message"
+                  ],
+                  "properties": {
+                    "statusCode": {
+                      "type": "number"
+                    },
+                    "error": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
           "422": {
             "description": "Unprocessable entity - semantic validation failed",
             "content": {
@@ -393803,6 +393966,16 @@
               }
             }
           },
+          "429": {
+            "description": "Too many requests - rate limit exceeded. Reachable on every API-key operation: the per-key cap sold with the plan answers `code: API_KEY_RATE_LIMITED` with `retry_after_seconds` and the `Retry-After` header. The global per-IP limiter can answer here too, with the same status and only `statusCode`, `error` and `message`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitedResponse"
+                }
+              }
+            }
+          },
           "500": {
             "description": "Internal server error",
             "content": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wevion/cli",
-  "version": "1.0.3946",
+  "version": "1.0.3957",
   "description": "Wevion API command-line interface — generated from the public OpenAPI spec",
   "type": "module",
   "bin": {