@epilot/pricing-client 3.51.1 → 3.51.2-alpha.0

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 a=i(t(466));r.default=a.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}/external-catalog":{"post":{"deprecated":true,"operationId":"$searchExternalCatalog","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"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}/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 a=r[i];if(void 0!==a)return a.exports;var n=r[i]={exports:{}};return e[i].call(n.exports,n,n.exports,t),n.exports}(390),i=exports;for(var a in t)i[a]=t[a];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/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

@@ -223,10 +223,9 @@
         "responses": {}
       }
     },
-    "/v1/public/integration/{integrationId}/external-catalog": {
+    "/v1/public/integration/{integrationId}/products": {
       "post": {
-        "deprecated": true,
-        "operationId": "$searchExternalCatalog",
+        "operationId": "$searchExternalProducts",
         "parameters": [
           {
             "in": "path",
@@ -243,9 +242,9 @@
         "responses": {}
       }
     },
-    "/v1/public/integration/{integrationId}/products": {
+    "/v1/public/integration/{integrationId}/products-recommendation": {
       "post": {
-        "operationId": "$searchExternalProducts",
+        "operationId": "$searchExternalProductsRecommendation",
         "parameters": [
           {
             "in": "path",

package/dist/openapi.d.ts

@@ -9071,6 +9071,10 @@ declare namespace Components {
         export interface SearchExternalCatalogParams {
             context: JourneyContext;
         }
+        export interface SearchExternalCatalogRecommendationsResult {
+            source: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem;
+            offers: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
+        }
         export interface SearchExternalCatalogResult {
             /**
              * The number of results returned.
@@ -9633,7 +9637,7 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
-    namespace $SearchExternalCatalog {
+    namespace $SearchExternalProducts {
         namespace Parameters {
             export type IntegrationId = Components.Schemas.IntegrationId;
         }
@@ -9647,7 +9651,7 @@ declare namespace Paths {
             export type $403 = Components.Schemas.Error;
         }
     }
-    namespace $SearchExternalProducts {
+    namespace $SearchExternalProductsRecommendation {
         namespace Parameters {
             export type IntegrationId = Components.Schemas.IntegrationId;
         }
@@ -9656,7 +9660,7 @@ declare namespace Paths {
         }
         export type RequestBody = Components.Schemas.SearchExternalCatalogParams;
         namespace Responses {
-            export type $200 = Components.Schemas.SearchExternalCatalogResult;
+            export type $200 = Components.Schemas.SearchExternalCatalogRecommendationsResult;
             export type $400 = Components.Schemas.Error;
             export type $403 = Components.Schemas.Error;
         }
@@ -11011,16 +11015,6 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
-  /**
-   * $searchExternalCatalog - searchExternalCatalog
-   * 
-   * Returns the list of available products (including computed prices) based on a given context.
-   */
-  '$searchExternalCatalog'(
-    parameters?: Parameters<Paths.$SearchExternalCatalog.PathParameters> | null,
-    data?: Paths.$SearchExternalCatalog.RequestBody,
-    config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.$SearchExternalCatalog.Responses.$200>
   /**
    * $searchExternalProducts - searchExternalProducts
    * 
@@ -11031,6 +11025,16 @@ export interface OperationMethods {
     data?: Paths.$SearchExternalProducts.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$SearchExternalProducts.Responses.$200>
+  /**
+   * $searchExternalProductsRecommendation - searchExternalProductsRecommendation
+   * 
+   * Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.
+   */
+  '$searchExternalProductsRecommendation'(
+    parameters?: Parameters<Paths.$SearchExternalProductsRecommendation.PathParameters> | null,
+    data?: Paths.$SearchExternalProductsRecommendation.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$SearchExternalProductsRecommendation.Responses.$200>
   /**
    * $searchProviders - searchProviders
    * 
@@ -11247,18 +11251,6 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
   }
-  ['/v1/public/integration/{integrationId}/external-catalog']: {
-    /**
-     * $searchExternalCatalog - searchExternalCatalog
-     * 
-     * Returns the list of available products (including computed prices) based on a given context.
-     */
-    'post'(
-      parameters?: Parameters<Paths.$SearchExternalCatalog.PathParameters> | null,
-      data?: Paths.$SearchExternalCatalog.RequestBody,
-      config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.$SearchExternalCatalog.Responses.$200>
-  }
   ['/v1/public/integration/{integrationId}/products']: {
     /**
      * $searchExternalProducts - searchExternalProducts
@@ -11271,6 +11263,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$SearchExternalProducts.Responses.$200>
   }
+  ['/v1/public/integration/{integrationId}/products-recommendation']: {
+    /**
+     * $searchExternalProductsRecommendation - searchExternalProductsRecommendation
+     * 
+     * Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.
+     */
+    'post'(
+      parameters?: Parameters<Paths.$SearchExternalProductsRecommendation.PathParameters> | null,
+      data?: Paths.$SearchExternalProductsRecommendation.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$SearchExternalProductsRecommendation.Responses.$200>
+  }
   ['/v1/public/integration/{integrationId}/providers:search']: {
     /**
      * $searchProviders - searchProviders
@@ -11472,6 +11476,7 @@ export type RedeemedPromo = Components.Schemas.RedeemedPromo;
 export type SalesTax = Components.Schemas.SalesTax;
 export type SaveIntegrationCredentialsParams = Components.Schemas.SaveIntegrationCredentialsParams;
 export type SearchExternalCatalogParams = Components.Schemas.SearchExternalCatalogParams;
+export type SearchExternalCatalogRecommendationsResult = Components.Schemas.SearchExternalCatalogRecommendationsResult;
 export type SearchExternalCatalogResult = Components.Schemas.SearchExternalCatalogResult;
 export type SearchProvidersParams = Components.Schemas.SearchProvidersParams;
 export type SearchProvidersResult = Components.Schemas.SearchProvidersResult;

package/dist/openapi.json

@@ -1682,11 +1682,10 @@
         }
       }
     },
-    "/v1/public/integration/{integrationId}/external-catalog": {
+    "/v1/public/integration/{integrationId}/products": {
       "post": {
-        "deprecated": true,
-        "description": "Returns the list of available products (including computed prices) based on a given context.",
-        "operationId": "$searchExternalCatalog",
+        "description": "Returns the list of available products with computed prices based on a given context and for a given org integration.",
+        "operationId": "$searchExternalProducts",
         "security": [
           {},
           {
@@ -1705,7 +1704,7 @@
             "example": "ikom"
           }
         ],
-        "summary": "searchExternalCatalog",
+        "summary": "searchExternalProducts",
         "tags": [
           "External Integrations API"
         ],
@@ -1845,10 +1844,10 @@
         }
       }
     },
-    "/v1/public/integration/{integrationId}/products": {
+    "/v1/public/integration/{integrationId}/products-recommendation": {
       "post": {
-        "description": "Returns the list of available products with computed prices based on a given context and for a given org integration.",
-        "operationId": "$searchExternalProducts",
+        "description": "Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.",
+        "operationId": "$searchExternalProductsRecommendation",
         "security": [
           {},
           {
@@ -1864,10 +1863,10 @@
               "$ref": "#/components/schemas/IntegrationId"
             },
             "required": true,
-            "example": "ikom"
+            "example": "external-catalog"
           }
         ],
-        "summary": "searchExternalProducts",
+        "summary": "searchExternalProductsRecommendation",
         "tags": [
           "External Integrations API"
         ],
@@ -1887,99 +1886,7 @@
             "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
-                          }
-                        }
-                      ]
-                    }
-                  }
+                  "$ref": "#/components/schemas/SearchExternalCatalogRecommendationsResult"
                 }
               }
             }
@@ -8179,6 +8086,24 @@
           "hits"
         ]
       },
+      "SearchExternalCatalogRecommendationsResult": {
+        "type": "object",
+        "properties": {
+          "source": {
+            "$ref": "#/components/schemas/ExternalCatalogItem"
+          },
+          "offers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ExternalCatalogItem"
+            }
+          }
+        },
+        "required": [
+          "source",
+          "offers"
+        ]
+      },
       "ExternalCatalogItem": {
         "type": "object",
         "description": "An external product & price information (already computed) from an external catalog.",

package/package.json

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