@epilot/pricing-client 3.57.0 → 3.59.0

package/dist/openapi.d.ts

@@ -3948,6 +3948,21 @@ declare namespace Components {
              */
             CompositePrice;
         }
+        /**
+         * Echo of the request parameters used to compute the price, in the caller-facing shape.
+         */
+        export interface ComputePriceInputs {
+            [name: string]: any;
+            type?: ProductCategory;
+            consumptionHT?: number;
+            consumptionNT?: number;
+            consumptionType?: ConsumptionTypeGetAg;
+            zipCode?: string;
+            city?: string;
+            providerId?: string;
+            billingPeriod?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+            referenceDate?: string; // date
+        }
         /**
          * The compute price payload
          */
@@ -3985,6 +4000,12 @@ declare namespace Components {
              * The optional reference date for the price computation (ISO 8601 format)
              */
             reference_date?: string; // date
+            /**
+             * The city the postal code belongs to. Not used for price computation,
+             * only echoed back in `inputs` for display purposes.
+             *
+             */
+            city?: string;
         }
         /**
          * The compute price payload for gas
@@ -4022,6 +4043,12 @@ declare namespace Components {
              * The optional reference date for the price computation (ISO 8601 format)
              */
             reference_date?: string; // date
+            /**
+             * The city the postal code belongs to. Not used for price computation,
+             * only echoed back in `inputs` for display purposes.
+             *
+             */
+            city?: string;
             /**
              * The type of energy to compute the price
              */
@@ -4064,6 +4091,12 @@ declare namespace Components {
              * The optional reference date for the price computation (ISO 8601 format)
              */
             reference_date?: string; // date
+            /**
+             * The city the postal code belongs to. Not used for price computation,
+             * only echoed back in `inputs` for display purposes.
+             *
+             */
+            city?: string;
             /**
              * The type of energy to compute the price
              */
@@ -4135,6 +4168,23 @@ declare namespace Components {
              */
             billing_period: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
             breakdown: /* Price breakdown */ ComputedPriceBreakdown;
+            /**
+             * A snapshot of the parameters this price was computed from, for display purposes
+             * (e.g. showing "computed for 3,500 kWh/year"). Included in the `_meta` signature.
+             *
+             */
+            inputs?: {
+                [name: string]: any;
+                type?: ProductCategory;
+                consumptionHT?: number;
+                consumptionNT?: number;
+                consumptionType?: ConsumptionTypeGetAg;
+                zipCode?: string;
+                city?: string;
+                providerId?: string;
+                billingPeriod?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+                referenceDate?: string; // date
+            };
             _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
@@ -5406,10 +5456,24 @@ declare namespace Components {
              */
             billing_period: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
             breakdown: /* Price breakdown */ ComputedPriceBreakdown;
-            _meta?: /* Signature meta data payload */ SignatureMeta;
+            /**
+             * A snapshot of the parameters this price was computed from, for display purposes
+             * (e.g. showing "computed for 3,500 kWh/year"). Included in the `_meta` signature.
+             *
+             */
             inputs?: {
                 [name: string]: any;
+                type?: ProductCategory;
+                consumptionHT?: number;
+                consumptionNT?: number;
+                consumptionType?: ConsumptionTypeGetAg;
+                zipCode?: string;
+                city?: string;
+                providerId?: string;
+                billingPeriod?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+                referenceDate?: string; // date
             };
+            _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
          * The provider entity
@@ -9752,6 +9816,179 @@ declare namespace Components {
              * }
              */
             ProductRecommendation[];
+            /**
+             * Context about what the recommendations were searched against.
+             */
+            source?: {
+                /**
+                 * The first line item of the contract used as source for the recommendation.
+                 * Carries the amounts the customer currently pays; only present when searching by contract_id.
+                 *
+                 */
+                item?: /**
+                 * The first line item of the contract used as source for the recommendation.
+                 * Carries the amounts the customer currently pays; only present when searching by contract_id.
+                 *
+                 */
+                /**
+                 * Represents a price item
+                 * example:
+                 * {
+                 *   "amount_subtotal": 10000,
+                 *   "amount_total": 10600,
+                 *   "currency": "EUR",
+                 *   "description": "Annual internet service",
+                 *   "price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
+                 *   "product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
+                 *   "taxes": [
+                 *     {
+                 *       "amount": 600,
+                 *       "tax": {
+                 *         "active": true,
+                 *         "description": "Without Behaviour",
+                 *         "rate": 6,
+                 *         "region": "DE",
+                 *         "type": "VAT",
+                 *         "_created_at": "2022-02-07T14:49:08.831Z",
+                 *         "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
+                 *         "_org": "739224",
+                 *         "_schema": "tax",
+                 *         "_title": "Tax Without Behaviour",
+                 *         "_updated_at": "2022-02-07T14:49:08.831Z"
+                 *       }
+                 *     },
+                 *     {
+                 *       "amount": 600,
+                 *       "tax": {
+                 *         "active": true,
+                 *         "description": "Without Behaviour",
+                 *         "rate": 6,
+                 *         "region": "DE",
+                 *         "type": "VAT",
+                 *         "_created_at": "2022-02-07T14:49:08.831Z",
+                 *         "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
+                 *         "_org": "739224",
+                 *         "_schema": "tax",
+                 *         "_title": "Tax Without Behaviour",
+                 *         "_updated_at": "2022-02-07T14:49:08.831Z"
+                 *       }
+                 *     }
+                 *   ],
+                 *   "unit_amount": 10000,
+                 *   "unit_amount_net": 10000,
+                 *   "pricing_model": "per_unit",
+                 *   "_price": {
+                 *     "unit_amount": 10000,
+                 *     "unit_amount_currency": "EUR",
+                 *     "unit_amount_decimal": "100.00",
+                 *     "sales_tax": "standard",
+                 *     "is_tax_inclusive": false,
+                 *     "price_display_in_journeys": "show_price",
+                 *     "type": "one_time",
+                 *     "billing_period": "weekly",
+                 *     "billing_duration_unit": "months",
+                 *     "notice_time_unit": "months",
+                 *     "termination_time_unit": "months",
+                 *     "renewal_duration_unit": "months",
+                 *     "_schema": "price",
+                 *     "_title": "Solar Panel Module",
+                 *     "description": "Solar Panel Module",
+                 *     "active": true,
+                 *     "tax": {
+                 *       "$relation": [
+                 *         {
+                 *           "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
+                 *         },
+                 *         {
+                 *           "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
+                 *         }
+                 *       ]
+                 *     },
+                 *     "_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
+                 *     "_org": "728",
+                 *     "_created_at": "2022-06-03T16:04:10.369Z",
+                 *     "_updated_at": "2022-06-03T16:04:10.369Z",
+                 *     "pricing_model": "per_unit"
+                 *   },
+                 *   "_product": {
+                 *     "name": "Cool box",
+                 *     "type": "product",
+                 *     "_id": "73f857a4-0fbc-4aa6-983f-87c0d6d410a6",
+                 *     "_title": "Cool box"
+                 *   }
+                 * }
+                 */
+                PriceItem | /**
+                 * Represents a composite price input to the pricing library.
+                 * example:
+                 * {
+                 *   "amount_subtotal": 10000,
+                 *   "amount_total": 10600,
+                 *   "currency": "EUR",
+                 *   "description": "Annual internet service",
+                 *   "price_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
+                 *   "product_id": "6241487f-b7fd-428b-ab92-24ee0b37fd84",
+                 *   "taxes": [
+                 *     {
+                 *       "amount": 600,
+                 *       "tax": {
+                 *         "active": true,
+                 *         "description": "Without Behaviour",
+                 *         "rate": 6,
+                 *         "region": "DE",
+                 *         "type": "VAT",
+                 *         "_created_at": "2022-02-07T14:49:08.831Z",
+                 *         "_id": "18bbbc2e-2c37-4f91-924a-07ae60d830e4",
+                 *         "_org": "739224",
+                 *         "_schema": "tax",
+                 *         "_title": "Tax Without Behaviour",
+                 *         "_updated_at": "2022-02-07T14:49:08.831Z"
+                 *       }
+                 *     }
+                 *   ],
+                 *   "unit_amount": 10000,
+                 *   "unit_amount_net": 10000,
+                 *   "pricing_model": "per_unit",
+                 *   "_price": {
+                 *     "unit_amount": 10000,
+                 *     "unit_amount_currency": "EUR",
+                 *     "unit_amount_decimal": "100.00",
+                 *     "sales_tax": "standard",
+                 *     "is_tax_inclusive": false,
+                 *     "price_display_in_journeys": "show_price",
+                 *     "type": "one_time",
+                 *     "billing_period": "weekly",
+                 *     "billing_duration_unit": "months",
+                 *     "notice_time_unit": "months",
+                 *     "termination_time_unit": "months",
+                 *     "renewal_duration_unit": "months",
+                 *     "_schema": "price",
+                 *     "_title": "Solar Panel Module",
+                 *     "description": "Solar Panel Module",
+                 *     "active": true,
+                 *     "tax": {
+                 *       "$relation": [
+                 *         {
+                 *           "entity_id": "24641e82-0690-4135-8b43-ef12a9b1c5dc"
+                 *         }
+                 *       ]
+                 *     },
+                 *     "_id": "7e24ff5d-d580-4136-a32f-19191eed039a",
+                 *     "_org": "728",
+                 *     "_created_at": "2022-06-03T16:04:10.369Z",
+                 *     "_updated_at": "2022-06-03T16:04:10.369Z",
+                 *     "pricing_model": "per_unit"
+                 *   },
+                 *   "_product": {
+                 *     "name": "Cool box",
+                 *     "type": "product",
+                 *     "_id": "73f857a4-0fbc-4aa6-983f-87c0d6d410a6",
+                 *     "_title": "Cool box"
+                 *   }
+                 * }
+                 */
+                CompositePriceItem;
+            };
         }
         /**
          * Product recommendations request payload
@@ -14290,6 +14527,7 @@ export type CheckoutMode = Components.Schemas.CheckoutMode;
 export type CompositePrice = Components.Schemas.CompositePrice;
 export type CompositePriceItem = Components.Schemas.CompositePriceItem;
 export type CompositePriceItemDto = Components.Schemas.CompositePriceItemDto;
+export type ComputePriceInputs = Components.Schemas.ComputePriceInputs;
 export type ComputePriceParams = Components.Schemas.ComputePriceParams;
 export type ComputePriceParamsBase = Components.Schemas.ComputePriceParamsBase;
 export type ComputePriceParamsGas = Components.Schemas.ComputePriceParamsGas;

package/dist/openapi.json

@@ -2534,6 +2534,7 @@
                     "type": "power",
                     "billing_period": "monthly",
                     "postal_code": "04109",
+                    "city": "Leipzig",
                     "consumption": 3500,
                     "association_id": "123456789"
                   }
@@ -2574,6 +2575,13 @@
                             "amount_decimal": "50.00"
                           }
                         }
+                      },
+                      "inputs": {
+                        "type": "power",
+                        "consumptionHT": 3500,
+                        "zipCode": "04109",
+                        "city": "Leipzig",
+                        "billingPeriod": "monthly"
                       }
                     }
                   }
@@ -7577,6 +7585,10 @@
             "description": "The optional reference date for the price computation (ISO 8601 format)",
             "type": "string",
             "format": "date"
+          },
+          "city": {
+            "description": "The city the postal code belongs to. Not used for price computation,\nonly echoed back in `inputs` for display purposes.\n",
+            "type": "string"
           }
         },
         "required": [
@@ -7816,6 +7828,14 @@
           "breakdown": {
             "$ref": "#/components/schemas/ComputedPriceBreakdown"
           },
+          "inputs": {
+            "description": "A snapshot of the parameters this price was computed from, for display purposes\n(e.g. showing \"computed for 3,500 kWh/year\"). Included in the `_meta` signature.\n",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ComputePriceInputs"
+              }
+            ]
+          },
           "_meta": {
             "$ref": "#/components/schemas/SignatureMeta"
           }
@@ -7828,6 +7848,49 @@
           "breakdown"
         ]
       },
+      "ComputePriceInputs": {
+        "type": "object",
+        "description": "Echo of the request parameters used to compute the price, in the caller-facing shape.",
+        "properties": {
+          "type": {
+            "$ref": "#/components/schemas/ProductCategory"
+          },
+          "consumptionHT": {
+            "type": "number"
+          },
+          "consumptionNT": {
+            "type": "number"
+          },
+          "consumptionType": {
+            "$ref": "#/components/schemas/ConsumptionTypeGetAg"
+          },
+          "zipCode": {
+            "type": "string"
+          },
+          "city": {
+            "type": "string"
+          },
+          "providerId": {
+            "type": "string"
+          },
+          "billingPeriod": {
+            "type": "string",
+            "enum": [
+              "weekly",
+              "monthly",
+              "every_quarter",
+              "every_6_months",
+              "yearly",
+              "one_time"
+            ]
+          },
+          "referenceDate": {
+            "type": "string",
+            "format": "date"
+          }
+        },
+        "additionalProperties": true
+      },
       "SpotMarketBiddingZone": {
         "description": "The bidding zone for a spot market price.",
         "type": "string",
@@ -11257,6 +11320,23 @@
             "items": {
               "$ref": "#/components/schemas/ProductRecommendation"
             }
+          },
+          "source": {
+            "type": "object",
+            "description": "Context about what the recommendations were searched against.",
+            "properties": {
+              "item": {
+                "description": "The first line item of the contract used as source for the recommendation.\nCarries the amounts the customer currently pays; only present when searching by contract_id.\n",
+                "anyOf": [
+                  {
+                    "$ref": "#/components/schemas/PriceItem"
+                  },
+                  {
+                    "$ref": "#/components/schemas/CompositePriceItem"
+                  }
+                ]
+              }
+            }
           }
         },
         "required": [

package/dist/schema-model.d.ts

@@ -28,11 +28,3 @@ export declare const DynamicTariffModeValues: {
     readonly dayAheadMarket: "day_ahead_market";
     readonly manual: "manual";
 };
-/**
- * Entity attribute types a conditional pricing variant may override (`overridable_attribute`).
- * An allowlist, so a new attribute type is never overridable by default. No pricing schema to
- * `satisfies` against — `models.test.ts` checks these against the entity spec.
- */
-export declare const OVERRIDABLE_ATTRIBUTE_TYPE_LIST: readonly ["string", "number", "currency", "boolean", "date", "datetime", "select", "radio", "multiselect", "checkbox", "country", "tags"];
-/** `string`, not a literal union, so callers can test an unnarrowed `attribute.type`. */
-export declare const OVERRIDABLE_ATTRIBUTE_TYPES: ReadonlySet<string>;

package/dist/schema-model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OVERRIDABLE_ATTRIBUTE_TYPES = exports.OVERRIDABLE_ATTRIBUTE_TYPE_LIST = exports.DynamicTariffModeValues = exports.TypeGetAgValues = exports.MarkupPricingModelValues = exports.PricingModelValues = void 0;
+exports.DynamicTariffModeValues = exports.TypeGetAgValues = exports.MarkupPricingModelValues = exports.PricingModelValues = void 0;
 /**
  * Runtime companions for spec enums, for consumers that need the values and not
  * just the union type.
@@ -31,25 +31,4 @@ exports.DynamicTariffModeValues = {
     dayAheadMarket: 'day_ahead_market',
     manual: 'manual',
 };
-/**
- * Entity attribute types a conditional pricing variant may override (`overridable_attribute`).
- * An allowlist, so a new attribute type is never overridable by default. No pricing schema to
- * `satisfies` against — `models.test.ts` checks these against the entity spec.
- */
-exports.OVERRIDABLE_ATTRIBUTE_TYPE_LIST = [
-    'string',
-    'number',
-    'currency',
-    'boolean',
-    'date',
-    'datetime',
-    'select',
-    'radio',
-    'multiselect',
-    'checkbox',
-    'country',
-    'tags',
-];
-/** `string`, not a literal union, so callers can test an unnarrowed `attribute.type`. */
-exports.OVERRIDABLE_ATTRIBUTE_TYPES = new Set(exports.OVERRIDABLE_ATTRIBUTE_TYPE_LIST);
 //# sourceMappingURL=schema-model.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.57.0",
+  "version": "3.59.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"
+}