@epilot/pricing-client 3.54.3 → 3.55.0

package/dist/openapi.d.ts

@@ -1638,6 +1638,16 @@ declare namespace Components {
          * The cashback period, for now it's limited to either 0 months or 12 months
          */
         export type CashbackPeriod = "0" | "12";
+        /**
+         * List of entity fields to include or exclude from the results.
+         *
+         * example:
+         * [
+         *   "!_files",
+         *   "!**.versions"
+         * ]
+         */
+        export type CatalogFieldsParam = string[];
         /**
          * A catalog search payload
          * example:
@@ -1669,6 +1679,16 @@ declare namespace Components {
              * When true, enables entity hydration to resolve nested $relation references in-place.
              */
             hydrate?: boolean;
+            fields?: /**
+             * List of entity fields to include or exclude from the results.
+             *
+             * example:
+             * [
+             *   "!_files",
+             *   "!**.versions"
+             * ]
+             */
+            CatalogFieldsParam;
             availability?: /* Availability filters dimensions */ AvailabilityFilters;
         }
         /**
@@ -4094,6 +4114,84 @@ declare namespace Components {
         export interface ComputedPriceComponents {
             [name: string]: /* The computed price */ ComputedBasePrice;
         }
+        /**
+         * An error from a conditional-pricing operation, carrying a machine-readable `code`
+         * from the conditional-pricing vocabulary plus any structured data about the failure,
+         * so a client can branch on the kind of failure rather than parse the message.
+         * Referenced only by the operations that emit these codes; every other operation
+         * keeps the plain `Error` shape.
+         *
+         */
+        export interface ConditionalPricingError {
+            /**
+             * Error message
+             */
+            message: string;
+            /**
+             * The HTTP status code
+             */
+            status?: number;
+            /**
+             * The cause of the error (visible for bad requests - http 400)
+             */
+            cause?: string;
+            /**
+             * The error message. Carries the same string as `message`, which the shared `Error`
+             * schema requires — `error` is the field responses have always used, and every caller
+             * to date reads. Declared here rather than on the shared `Error` because a request
+             * validation failure puts a list of validation errors in this field instead of a
+             * string, and those responses reference `Error` directly.
+             *
+             */
+            error?: string;
+            code?: /**
+             * Machine-readable failure mode of a conditional-pricing operation, allowing clients
+             * to branch on the kind of failure instead of parsing the error message.
+             *
+             * - `NOT_FOUND` (404): the addressed entity, variant or version does not exist
+             * - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
+             * - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
+             * - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
+             * - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
+             * - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
+             * - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
+             * - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
+             * - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
+             * - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
+             *
+             * Each code is emitted with the HTTP status shown above, and only with that status.
+             *
+             */
+            ConditionalPricingErrorCode;
+            /**
+             * Structured data about the failure, shaped by the accompanying `code`
+             * (e.g. the candidate variants of an `ambiguous-resolution`). Only present
+             * when the failure has structured data to report, and never without a `code`.
+             *
+             */
+            details?: {
+                [name: string]: any;
+            };
+        }
+        /**
+         * Machine-readable failure mode of a conditional-pricing operation, allowing clients
+         * to branch on the kind of failure instead of parsing the error message.
+         *
+         * - `NOT_FOUND` (404): the addressed entity, variant or version does not exist
+         * - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
+         * - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
+         * - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
+         * - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
+         * - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
+         * - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
+         * - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
+         * - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
+         * - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
+         *
+         * Each code is emitted with the HTTP status shown above, and only with that status.
+         *
+         */
+        export type ConditionalPricingErrorCode = "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "SUPERSEDED_VERSION" | "CONDITION_UNDEFINED" | "OPERATOR_UNSUPPORTED" | "CONTEXT_FORMAT_INVALID" | "TOO_MANY_MATCHES" | "WRITE_CONFLICT";
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
         /**
          * The coupon entity
@@ -9760,13 +9858,50 @@ declare namespace Components {
              *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
-            Tax;
+            Tax | /**
+             * A minimal, ad-hoc tax rate for line items with no backing tax entity
+             * in the catalog (e.g. a fully custom/composite price component built
+             * by a client with no product/price reference to resolve tax from).
+             * Mirrors how PriceItem relates to Price: unlike Tax, this has no
+             * entity identity — it isn't persisted and can't be looked up by _id,
+             * so it can't be shared/reused across price items the way a catalog
+             * Tax can.
+             *
+             * example:
+             * {
+             *   "rate": 19,
+             *   "type": "VAT",
+             *   "description": "Custom 19% VAT"
+             * }
+             */
+            TaxItem;
         }
         export interface TaxBreakdownInfo {
             rate?: number | null;
             type?: "VAT" | "GST" | "Custom";
             _id?: string;
         }
+        /**
+         * A minimal, ad-hoc tax rate for line items with no backing tax entity
+         * in the catalog (e.g. a fully custom/composite price component built
+         * by a client with no product/price reference to resolve tax from).
+         * Mirrors how PriceItem relates to Price: unlike Tax, this has no
+         * entity identity — it isn't persisted and can't be looked up by _id,
+         * so it can't be shared/reused across price items the way a catalog
+         * Tax can.
+         *
+         * example:
+         * {
+         *   "rate": 19,
+         *   "type": "VAT",
+         *   "description": "Custom 19% VAT"
+         * }
+         */
+        export interface TaxItem {
+            type: "VAT" | "GST" | "Custom";
+            rate: number | null;
+            description?: string;
+        }
         export interface TierDetails {
             quantity: number;
             unit_amount: number;
@@ -12000,6 +12135,7 @@ export type CartDto = Components.Schemas.CartDto;
 export type CashbackAmount = Components.Schemas.CashbackAmount;
 export type CashbackAmounts = Components.Schemas.CashbackAmounts;
 export type CashbackPeriod = Components.Schemas.CashbackPeriod;
+export type CatalogFieldsParam = Components.Schemas.CatalogFieldsParam;
 export type CatalogSearch = Components.Schemas.CatalogSearch;
 export type CatalogSearchResult = Components.Schemas.CatalogSearchResult;
 export type CheckoutCart = Components.Schemas.CheckoutCart;
@@ -12016,6 +12152,8 @@ export type ComputePriceResult = Components.Schemas.ComputePriceResult;
 export type ComputedBasePrice = Components.Schemas.ComputedBasePrice;
 export type ComputedPriceBreakdown = Components.Schemas.ComputedPriceBreakdown;
 export type ComputedPriceComponents = Components.Schemas.ComputedPriceComponents;
+export type ConditionalPricingError = Components.Schemas.ConditionalPricingError;
+export type ConditionalPricingErrorCode = Components.Schemas.ConditionalPricingErrorCode;
 export type ConsumptionTypeGetAg = Components.Schemas.ConsumptionTypeGetAg;
 export type Coupon = Components.Schemas.Coupon;
 export type CouponItem = Components.Schemas.CouponItem;
@@ -12120,6 +12258,7 @@ export type TaxAmount = Components.Schemas.TaxAmount;
 export type TaxAmountBreakdown = Components.Schemas.TaxAmountBreakdown;
 export type TaxAmountDto = Components.Schemas.TaxAmountDto;
 export type TaxBreakdownInfo = Components.Schemas.TaxBreakdownInfo;
+export type TaxItem = Components.Schemas.TaxItem;
 export type TierDetails = Components.Schemas.TierDetails;
 export type TotalDetails = Components.Schemas.TotalDetails;
 export type TypeGetAg = Components.Schemas.TypeGetAg;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Pricing API",
     "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n\n### Spot Market API\nProvides endpoints to fetch (historic) spot market price data.\n\n### External Integrations API\nProvides endpoints for external integrations. E.g. GetAG.\n\n### External Catalog API\nProvides endpoints for external catalog.\n\n### Product Recommendations API\nProvides endpoints for product recommendations.\n",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "termsOfService": "https://epilot.cloud/agb",
     "contact": {
       "name": "Support",
@@ -3430,6 +3430,22 @@
           "external-catalog"
         ]
       },
+      "ConditionalPricingErrorCode": {
+        "type": "string",
+        "description": "Machine-readable failure mode of a conditional-pricing operation, allowing clients\nto branch on the kind of failure instead of parsing the error message.\n\n- `NOT_FOUND` (404): the addressed entity, variant or version does not exist\n- `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested\n- `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant\n- `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant\n- `SUPERSEDED_VERSION` (409): the addressed version has been superseded\n- `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define\n- `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type\n- `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type\n- `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap\n- `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`\n\nEach code is emitted with the HTTP status shown above, and only with that status.\n",
+        "enum": [
+          "NOT_FOUND",
+          "AMBIGUOUS_RESOLUTION",
+          "TUPLE_CONFLICT",
+          "VERSION_CONFLICT",
+          "SUPERSEDED_VERSION",
+          "CONDITION_UNDEFINED",
+          "OPERATOR_UNSUPPORTED",
+          "CONTEXT_FORMAT_INVALID",
+          "TOO_MANY_MATCHES",
+          "WRITE_CONFLICT"
+        ]
+      },
       "Error": {
         "required": [
           "message"
@@ -3449,6 +3465,31 @@
           }
         }
       },
+      "ConditionalPricingError": {
+        "description": "An error from a conditional-pricing operation, carrying a machine-readable `code`\nfrom the conditional-pricing vocabulary plus any structured data about the failure,\nso a client can branch on the kind of failure rather than parse the message.\nReferenced only by the operations that emit these codes; every other operation\nkeeps the plain `Error` shape.\n",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/Error"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "error": {
+                "type": "string",
+                "description": "The error message. Carries the same string as `message`, which the shared `Error`\nschema requires — `error` is the field responses have always used, and every caller\nto date reads. Declared here rather than on the shared `Error` because a request\nvalidation failure puts a list of validation errors in this field instead of a\nstring, and those responses reference `Error` directly.\n"
+              },
+              "code": {
+                "$ref": "#/components/schemas/ConditionalPricingErrorCode"
+              },
+              "details": {
+                "type": "object",
+                "additionalProperties": true,
+                "description": "Structured data about the failure, shaped by the accompanying `code`\n(e.g. the candidate variants of an `ambiguous-resolution`). Only present\nwhen the failure has structured data to report, and never without a `code`.\n"
+              }
+            }
+          }
+        ]
+      },
       "Product": {
         "type": "object",
         "description": "The product entity",
@@ -5569,6 +5610,9 @@
             "description": "When true, enables entity hydration to resolve nested $relation references in-place.",
             "default": false
           },
+          "fields": {
+            "$ref": "#/components/schemas/CatalogFieldsParam"
+          },
           "availability": {
             "$ref": "#/components/schemas/AvailabilityFilters"
           }
@@ -5583,6 +5627,17 @@
           "q"
         ]
       },
+      "CatalogFieldsParam": {
+        "type": "array",
+        "description": "List of entity fields to include or exclude from the results.\n",
+        "items": {
+          "type": "string"
+        },
+        "example": [
+          "!_files",
+          "!**.versions"
+        ]
+      },
       "CatalogSearchResult": {
         "description": "The query result payload",
         "type": "object",
@@ -6953,7 +7008,14 @@
             "description": "The deprecated tax rate applied.\nThis field has been deprecated in favor of the new Tax Management. You should use the new tax fields pointing to a proper tax entity.\n"
           },
           "tax": {
-            "$ref": "#/components/schemas/Tax"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/Tax"
+              },
+              {
+                "$ref": "#/components/schemas/TaxItem"
+              }
+            ]
           }
         }
       },
@@ -8429,6 +8491,37 @@
           "_updated_at": "2021-02-09T12:41:43.662Z"
         }
       },
+      "TaxItem": {
+        "type": "object",
+        "description": "A minimal, ad-hoc tax rate for line items with no backing tax entity\nin the catalog (e.g. a fully custom/composite price component built\nby a client with no product/price reference to resolve tax from).\nMirrors how PriceItem relates to Price: unlike Tax, this has no\nentity identity — it isn't persisted and can't be looked up by _id,\nso it can't be shared/reused across price items the way a catalog\nTax can.\n",
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "rate"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "VAT",
+              "GST",
+              "Custom"
+            ]
+          },
+          "rate": {
+            "type": "number",
+            "nullable": true
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "rate": 19,
+          "type": "VAT",
+          "description": "Custom 19% VAT"
+        }
+      },
       "TaxBreakdownInfo": {
         "type": "object",
         "properties": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.54.3",
+  "version": "3.55.0",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,6 +24,18 @@
     "cart",
     "pricing"
   ],
+  "scripts": {
+    "test": "vitest",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/pricing-api.yaml",
+    "openapi:local": "node ../../scripts/update-openapi.js ../../../pricing-api/lambda/ApiHandlerFunction/openapi.yml",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
+    "build": "tsc && npm run build:patch && npm run bundle-definition",
+    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
+    "build:watch": "npm run build && tsc -w",
+    "prepublishOnly": "npm run typegen && npm run build",
+    "lint": "biome check src"
+  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -60,16 +72,5 @@
     "webpack": "^5.18.0",
     "webpack-cli": "^4.4.0"
   },
-  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7",
-  "scripts": {
-    "test": "vitest",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/pricing-api.yaml",
-    "openapi:local": "node ../../scripts/update-openapi.js ../../../pricing-api/lambda/ApiHandlerFunction/openapi.yml",
-    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
-    "build": "tsc && npm run build:patch && npm run bundle-definition",
-    "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
-    "build:watch": "npm run build && tsc -w",
-    "lint": "biome check src"
-  }
-}
+  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
+}