@epilot/pricing-client 3.51.2 → 3.51.3

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={390:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=i(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/validate-promo-codes":{"post":{"operationId":"$validatePromoCodes","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"responses":{}}},"/v1/public/historicMarketPrices":{"get":{"operationId":"$historicMarketPrices","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"frequency","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/averageMarketPrice":{"get":{"operationId":"$averageMarketPrice","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/integration/{integrationId}/products":{"post":{"operationId":"$searchExternalProducts","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/products-recommendation":{"post":{"operationId":"$searchExternalProductsRecommendation","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/public/product-recommendations":{"post":{"operationId":"$productRecommendations","parameters":[{"in":"header","name":"X-Ivy-Org-ID"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{}}')}},r={},t=function t(i){var n=r[i];if(void 0!==n)return n.exports;var a=r[i]={exports:{}};return e[i].call(a.exports,a,a.exports,t),a.exports}(390),i=exports;for(var n in t)i[n]=t[n];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={390:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=i(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/pricing:compute":{"post":{"operationId":"$calculatePricingDetails","requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID"},{"in":"header","name":"Authorization"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/catalog":{"post":{"operationId":"$privateSearchCatalog","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/validate-promo-codes":{"post":{"operationId":"$validatePromoCodes","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"responses":{}}},"/v1/public/historicMarketPrices":{"get":{"operationId":"$historicMarketPrices","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"frequency","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/averageMarketPrice":{"get":{"operationId":"$averageMarketPrice","parameters":[{"in":"query","name":"market","required":true},{"in":"query","name":"bidding_zone","required":true},{"in":"query","name":"from","required":true},{"in":"query","name":"to","required":true}],"responses":{}}},"/v1/public/integration/{integrationId}/products":{"post":{"operationId":"$searchExternalProducts","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/products-recommendation":{"post":{"operationId":"$searchExternalProductsRecommendation","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"responses":{}}},"/v1/public/external-catalog/products":{"post":{"operationId":"$getExternalCatalogProducts","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/public/product-recommendations":{"post":{"operationId":"$productRecommendations","parameters":[{"in":"header","name":"X-Ivy-Org-ID"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{}}')}},r={},t=function t(i){var n=r[i];if(void 0!==n)return n.exports;var a=r[i]={exports:{}};return e[i].call(a.exports,a,a.exports,t),a.exports}(390),i=exports;for(var n in t)i[n]=t[n];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -376,6 +376,18 @@
         "responses": {}
       }
     },
+    "/v1/public/external-catalog/products": {
+      "post": {
+        "operationId": "$getExternalCatalogProducts",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
     "/v1/public/product-recommendations": {
       "post": {
         "operationId": "$productRecommendations",

package/dist/openapi.d.ts

@@ -4356,6 +4356,16 @@ declare namespace Components {
          * EUR
          */
         export type Currency = string;
+        /**
+         * A custom context object. E.g. for Portal context.
+         * example:
+         * {
+         *   "custom_context_key": "custom_context_value"
+         * }
+         */
+        export interface CustomContext {
+            [name: string]: any;
+        }
         export interface Customer {
             first_name?: string;
             last_name?: string;
@@ -4506,6 +4516,92 @@ declare namespace Components {
              */
             cause?: string;
         }
+        /**
+         * The request payload for the external catalog configuration service.
+         * example:
+         * {
+         *   "config": {
+         *     "appId": "1234567890",
+         *     "componentId": "1234567890",
+         *     "hookId": "1234567890"
+         *   }
+         * }
+         */
+        export interface ExternalCatalogConfigurationRequest {
+            config?: {
+                /**
+                 * The app id.
+                 * example:
+                 * 1234567890
+                 */
+                appId?: string;
+                /**
+                 * The component id.
+                 * example:
+                 * 1234567890
+                 */
+                componentId?: string;
+                /**
+                 * The hook id.
+                 * example:
+                 * 1234567890
+                 */
+                hookId?: string;
+            };
+        }
+        /**
+         * The request payload for the external catalog service with a custom context. E.g. for requests from the Portal.
+         * example:
+         * {
+         *   "config": {
+         *     "appId": "1234567890",
+         *     "componentId": "1234567890",
+         *     "hookId": "1234567890"
+         *   },
+         *   "origin": "custom",
+         *   "context": {
+         *     "user_id": "user-12345",
+         *     "session_id": "session-67890",
+         *     "custom_context_key": "custom_context_value"
+         *   }
+         * }
+         */
+        export interface ExternalCatalogCustomRequest {
+            config?: {
+                /**
+                 * The app id.
+                 * example:
+                 * 1234567890
+                 */
+                appId?: string;
+                /**
+                 * The component id.
+                 * example:
+                 * 1234567890
+                 */
+                componentId?: string;
+                /**
+                 * The hook id.
+                 * example:
+                 * 1234567890
+                 */
+                hookId?: string;
+            };
+            /**
+             * The origin of the request.
+             * example:
+             * custom
+             */
+            origin: "custom";
+            context: /**
+             * A custom context object. E.g. for Portal context.
+             * example:
+             * {
+             *   "custom_context_key": "custom_context_value"
+             * }
+             */
+            CustomContext;
+        }
         /**
          * An external product & price information (already computed) from an external catalog.
          */
@@ -4513,6 +4609,140 @@ declare namespace Components {
             pricing_details: /* The result from the calculation of a set of price items. */ PricingDetails;
             _meta: /* Signature meta data payload */ SignatureMeta;
         }
+        /**
+         * The request payload for the external catalog service with a journey context.
+         * example:
+         * {
+         *   "config": {
+         *     "appId": "1234567890",
+         *     "componentId": "1234567890",
+         *     "hookId": "1234567890"
+         *   },
+         *   "origin": "journey",
+         *   "context": {
+         *     "journey_id": "8d0a2235-97ce-42d0-88a3-e374634ca44e",
+         *     "entity_id": "9e1b3346-a8df-53e1-99b4-f485745db55f",
+         *     "journey_name": "Product Selection Journey",
+         *     "journey_tags": [
+         *       "electricity",
+         *       "residential"
+         *     ],
+         *     "journey_url_params": {
+         *       "utm_source": "google",
+         *       "utm_campaign": "spring2024"
+         *     },
+         *     "current_step_name": "Product Selection",
+         *     "current_block_name": "Energy Products",
+         *     "steps_data": [
+         *       {
+         *         "step_name": "Address Information",
+         *         "step_index": 0,
+         *         "blocks": {
+         *           "Adresse": {
+         *             "countryCode": "DE",
+         *             "city": "Koblenz",
+         *             "zipCode": "56068",
+         *             "streetName": "Am Alten Hospital",
+         *             "houseNumber": "123"
+         *           }
+         *         }
+         *       }
+         *     ]
+         *   }
+         * }
+         */
+        export interface ExternalCatalogJourneyRequest {
+            config?: {
+                /**
+                 * The app id.
+                 * example:
+                 * 1234567890
+                 */
+                appId?: string;
+                /**
+                 * The component id.
+                 * example:
+                 * 1234567890
+                 */
+                componentId?: string;
+                /**
+                 * The hook id.
+                 * example:
+                 * 1234567890
+                 */
+                hookId?: string;
+            };
+            /**
+             * The origin of the request.
+             * example:
+             * journey
+             */
+            origin: "journey";
+            context: JourneyContext;
+        }
+        /**
+         * The request payload for the external catalog service.
+         */
+        export type ExternalCatalogRequest = /* The request payload for the external catalog service. */ /**
+         * The request payload for the external catalog service with a journey context.
+         * example:
+         * {
+         *   "config": {
+         *     "appId": "1234567890",
+         *     "componentId": "1234567890",
+         *     "hookId": "1234567890"
+         *   },
+         *   "origin": "journey",
+         *   "context": {
+         *     "journey_id": "8d0a2235-97ce-42d0-88a3-e374634ca44e",
+         *     "entity_id": "9e1b3346-a8df-53e1-99b4-f485745db55f",
+         *     "journey_name": "Product Selection Journey",
+         *     "journey_tags": [
+         *       "electricity",
+         *       "residential"
+         *     ],
+         *     "journey_url_params": {
+         *       "utm_source": "google",
+         *       "utm_campaign": "spring2024"
+         *     },
+         *     "current_step_name": "Product Selection",
+         *     "current_block_name": "Energy Products",
+         *     "steps_data": [
+         *       {
+         *         "step_name": "Address Information",
+         *         "step_index": 0,
+         *         "blocks": {
+         *           "Adresse": {
+         *             "countryCode": "DE",
+         *             "city": "Koblenz",
+         *             "zipCode": "56068",
+         *             "streetName": "Am Alten Hospital",
+         *             "houseNumber": "123"
+         *           }
+         *         }
+         *       }
+         *     ]
+         *   }
+         * }
+         */
+        ExternalCatalogJourneyRequest | /**
+         * The request payload for the external catalog service with a custom context. E.g. for requests from the Portal.
+         * example:
+         * {
+         *   "config": {
+         *     "appId": "1234567890",
+         *     "componentId": "1234567890",
+         *     "hookId": "1234567890"
+         *   },
+         *   "origin": "custom",
+         *   "context": {
+         *     "user_id": "user-12345",
+         *     "session_id": "session-67890",
+         *     "custom_context_key": "custom_context_value"
+         *   }
+         * }
+         */
+        ExternalCatalogCustomRequest;
         /**
          * example:
          * {
@@ -4923,7 +5153,7 @@ declare namespace Components {
          */
         export type IntegrationAuthCredentials = /* The auth credentials for external integrations */ BasicAuthIntegration | OAuthIntegration;
         export type IntegrationCredentialsResult = /* The auth credentials for external integrations */ IntegrationAuthCredentials;
-        export type IntegrationId = "getag" | "ikom" | "external-catalog";
+        export type IntegrationId = "getag" | "external-catalog";
         export interface JourneyContext {
             /**
              * The ID of the journey.
@@ -9514,6 +9744,14 @@ declare namespace Paths {
             export type $404 = Components.Schemas.Error;
         }
     }
+    namespace $GetExternalCatalogProducts {
+        export type RequestBody = /* The request payload for the external catalog service. */ Components.Schemas.ExternalCatalogRequest;
+        namespace Responses {
+            export type $200 = Components.Schemas.SearchExternalCatalogResult;
+            export type $400 = Components.Schemas.Error;
+            export type $403 = Components.Schemas.Error;
+        }
+    }
     namespace $HistoricMarketPrices {
         namespace Parameters {
             export type BiddingZone = /* The bidding zone for a spot market price. */ Components.Schemas.SpotMarketBiddingZone;
@@ -11095,6 +11333,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
+  /**
+   * $getExternalCatalogProducts - getExternalCatalogProducts
+   * 
+   * Returns the list of available external catalog products with computed prices based on a given context
+   */
+  '$getExternalCatalogProducts'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.$GetExternalCatalogProducts.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$GetExternalCatalogProducts.Responses.$200>
   /**
    * $productRecommendations - productRecommendations
    * 
@@ -11347,6 +11595,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
   }
+  ['/v1/public/external-catalog/products']: {
+    /**
+     * $getExternalCatalogProducts - getExternalCatalogProducts
+     * 
+     * Returns the list of available external catalog products with computed prices based on a given context
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.$GetExternalCatalogProducts.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$GetExternalCatalogProducts.Responses.$200>
+  }
   ['/v1/public/product-recommendations']: {
     /**
      * $productRecommendations - productRecommendations
@@ -11406,6 +11666,7 @@ export type Coupon = Components.Schemas.Coupon;
 export type CouponItem = Components.Schemas.CouponItem;
 export type CouponWithoutPromoCodes = Components.Schemas.CouponWithoutPromoCodes;
 export type Currency = Components.Schemas.Currency;
+export type CustomContext = Components.Schemas.CustomContext;
 export type Customer = Components.Schemas.Customer;
 export type DiscountAmounts = Components.Schemas.DiscountAmounts;
 export type DynamicTariffInterval = Components.Schemas.DynamicTariffInterval;
@@ -11414,7 +11675,11 @@ export type EntityId = Components.Schemas.EntityId;
 export type EntityItem = Components.Schemas.EntityItem;
 export type EntityRelation = Components.Schemas.EntityRelation;
 export type Error = Components.Schemas.Error;
+export type ExternalCatalogConfigurationRequest = Components.Schemas.ExternalCatalogConfigurationRequest;
+export type ExternalCatalogCustomRequest = Components.Schemas.ExternalCatalogCustomRequest;
 export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
+export type ExternalCatalogJourneyRequest = Components.Schemas.ExternalCatalogJourneyRequest;
+export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
 export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
 export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
 export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "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.\n\n### Product Recommendations API\nProvides endpoints for product recommendations.\n",
+    "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",
     "termsOfService": "https://epilot.cloud/agb",
     "contact": {
@@ -38,7 +38,11 @@
     },
     {
       "name": "External Integrations API",
-      "description": "Provides endpoints for external integrations.\n"
+      "description": "Provides endpoints for external integrations. E.g. GetAG.\n"
+    },
+    {
+      "name": "External Catalog API",
+      "description": "Provides endpoints for external catalog.\n"
     },
     {
       "name": "Product Recommendations API",
@@ -1701,7 +1705,7 @@
               "$ref": "#/components/schemas/IntegrationId"
             },
             "required": true,
-            "example": "ikom"
+            "example": "external-catalog"
           }
         ],
         "summary": "searchExternalProducts",
@@ -2700,6 +2704,156 @@
         }
       }
     },
+    "/v1/public/external-catalog/products": {
+      "post": {
+        "description": "Returns the list of available external catalog products with computed prices based on a given context",
+        "operationId": "$getExternalCatalogProducts",
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
+        "summary": "getExternalCatalogProducts",
+        "tags": [
+          "External Catalog API"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExternalCatalogRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The available external catalog products response payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchExternalCatalogResult"
+                },
+                "examples": {
+                  "External products": {
+                    "value": {
+                      "hits": 1,
+                      "results": [
+                        {
+                          "pricing_details": {
+                            "items": [
+                              {
+                                "_id": "price-12312414",
+                                "price_id": "price-12312414",
+                                "is_composite_price": true,
+                                "description": "Home Energy Package Composite",
+                                "item_components": [
+                                  {
+                                    "_id": "price-12312414-component-0",
+                                    "price_id": "price-12312414-component-0",
+                                    "description": "Working Price",
+                                    "is_tax_inclusive": true,
+                                    "amount_total_decimal": "100",
+                                    "amount_total": 10000,
+                                    "amount_subtotal_decimal": "100",
+                                    "amount_subtotal": 10000,
+                                    "unit_amount": 10,
+                                    "unit_amount_gross": 10,
+                                    "unit_amount_gross_decimal": "0.10",
+                                    "unit_amount_net": 10,
+                                    "unit_amount_net_decimal": "0.10",
+                                    "billing_period": "monthly",
+                                    "type": "recurring",
+                                    "taxes": [],
+                                    "pricing_model": "per_unit",
+                                    "quantity": 1,
+                                    "_price": {
+                                      "_id": "price-12312414-component-0",
+                                      "unit_amount_currency": "EUR",
+                                      "description": "Working Price",
+                                      "is_tax_inclusive": true,
+                                      "unit_amount": 10,
+                                      "unit_amount_decimal": "0.10",
+                                      "unit": "kWh",
+                                      "billing_period": "monthly",
+                                      "type": "recurring",
+                                      "billing_duration_amount": 24,
+                                      "billing_duration_unit": "months",
+                                      "notice_time_amount": 3,
+                                      "notice_time_unit": "months",
+                                      "termination_time_amount": 3,
+                                      "termination_time_unit": "months",
+                                      "renewal_duration_amount": 12,
+                                      "renewal_duration_unit": "months",
+                                      "active": true,
+                                      "is_composite_price": false,
+                                      "variable_price": true,
+                                      "pricing_model": "per_unit",
+                                      "price_display_in_journeys": "show_price"
+                                    }
+                                  }
+                                ]
+                              }
+                            ],
+                            "currency": "EUR",
+                            "amount_subtotal": 10000,
+                            "amount_total": 10000,
+                            "amount_tax": 0,
+                            "total_details": {
+                              "amount_tax": 0,
+                              "breakdown": {
+                                "taxes": [],
+                                "recurrences": [
+                                  {
+                                    "type": "recurring",
+                                    "billing_period": "monthly",
+                                    "amount_total": 10000,
+                                    "amount_total_decimal": "100.00",
+                                    "amount_subtotal": 10000,
+                                    "amount_subtotal_decimal": "100.00",
+                                    "amount_tax": 0
+                                  }
+                                ]
+                              }
+                            }
+                          },
+                          "_meta": {
+                            "signature": "abc123",
+                            "timestamp": 1712049221642
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden, no valid configuration found for the given integration / organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/public/product-recommendations": {
       "post": {
         "description": "Get a list of product recommendations based on the search parameters.",
@@ -2852,7 +3006,6 @@
         "type": "string",
         "enum": [
           "getag",
-          "ikom",
           "external-catalog"
         ]
       },
@@ -8282,6 +8435,164 @@
           "context"
         ]
       },
+      "ExternalCatalogRequest": {
+        "description": "The request payload for the external catalog service.",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/ExternalCatalogJourneyRequest"
+          },
+          {
+            "$ref": "#/components/schemas/ExternalCatalogCustomRequest"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "origin",
+          "mapping": {
+            "journey": "#/components/schemas/ExternalCatalogJourneyRequest",
+            "custom": "#/components/schemas/ExternalCatalogCustomRequest"
+          }
+        }
+      },
+      "ExternalCatalogConfigurationRequest": {
+        "type": "object",
+        "description": "The request payload for the external catalog configuration service.",
+        "properties": {
+          "config": {
+            "type": "object",
+            "properties": {
+              "appId": {
+                "type": "string",
+                "description": "The app id.",
+                "example": "1234567890"
+              },
+              "componentId": {
+                "type": "string",
+                "description": "The component id.",
+                "example": "1234567890"
+              },
+              "hookId": {
+                "type": "string",
+                "description": "The hook id.",
+                "example": "1234567890"
+              }
+            }
+          }
+        },
+        "example": {
+          "config": {
+            "appId": "1234567890",
+            "componentId": "1234567890",
+            "hookId": "1234567890"
+          }
+        }
+      },
+      "ExternalCatalogJourneyRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ExternalCatalogConfigurationRequest"
+          },
+          {
+            "type": "object",
+            "description": "The request payload for the external catalog service with a journey context.",
+            "properties": {
+              "origin": {
+                "type": "string",
+                "description": "The origin of the request.",
+                "enum": [
+                  "journey"
+                ],
+                "example": "journey"
+              },
+              "context": {
+                "$ref": "#/components/schemas/JourneyContext"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "origin",
+              "context"
+            ],
+            "example": {
+              "origin": "journey",
+              "context": {
+                "journey_id": "8d0a2235-97ce-42d0-88a3-e374634ca44e",
+                "entity_id": "9e1b3346-a8df-53e1-99b4-f485745db55f",
+                "journey_name": "Product Selection Journey",
+                "journey_tags": [
+                  "electricity",
+                  "residential"
+                ],
+                "journey_url_params": {
+                  "utm_source": "google",
+                  "utm_campaign": "spring2024"
+                },
+                "current_step_name": "Product Selection",
+                "current_block_name": "Energy Products",
+                "steps_data": [
+                  {
+                    "step_name": "Address Information",
+                    "step_index": 0,
+                    "blocks": {
+                      "Adresse": {
+                        "countryCode": "DE",
+                        "city": "Koblenz",
+                        "zipCode": "56068",
+                        "streetName": "Am Alten Hospital",
+                        "houseNumber": "123"
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        ]
+      },
+      "ExternalCatalogCustomRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ExternalCatalogConfigurationRequest"
+          },
+          {
+            "type": "object",
+            "description": "The request payload for the external catalog service with a custom context. E.g. for requests from the Portal.",
+            "properties": {
+              "origin": {
+                "type": "string",
+                "description": "The origin of the request.",
+                "enum": [
+                  "custom"
+                ],
+                "example": "custom"
+              },
+              "context": {
+                "$ref": "#/components/schemas/CustomContext"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "origin",
+              "context"
+            ],
+            "example": {
+              "origin": "custom",
+              "context": {
+                "user_id": "user-12345",
+                "session_id": "session-67890",
+                "custom_context_key": "custom_context_value"
+              }
+            }
+          }
+        ]
+      },
+      "CustomContext": {
+        "type": "object",
+        "description": "A custom context object. E.g. for Portal context.",
+        "additionalProperties": true,
+        "example": {
+          "custom_context_key": "custom_context_value"
+        }
+      },
       "JourneyContext": {
         "type": "object",
         "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.51.2",
+  "version": "3.51.3",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",