@epilot/pricing-client 3.51.1 → 3.51.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi-runtime.json +4 -5
  3. package/dist/openapi.d.ts +30 -25
  4. package/dist/openapi.json +307 -80
  5. package/package.json +1 -1
package/dist/definition.js CHANGED
@@ -1 +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})})();
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})})();
package/dist/openapi-runtime.json CHANGED
@@ -223,10 +223,9 @@
223
223
  "responses": {}
224
224
  }
225
225
  },
226
- "/v1/public/integration/{integrationId}/external-catalog": {
226
+ "/v1/public/integration/{integrationId}/products": {
227
227
  "post": {
228
- "deprecated": true,
229
- "operationId": "$searchExternalCatalog",
228
+ "operationId": "$searchExternalProducts",
230
229
  "parameters": [
231
230
  {
232
231
  "in": "path",
@@ -243,9 +242,9 @@
243
242
  "responses": {}
244
243
  }
245
244
  },
246
- "/v1/public/integration/{integrationId}/products": {
245
+ "/v1/public/integration/{integrationId}/products-recommendation": {
247
246
  "post": {
248
- "operationId": "$searchExternalProducts",
247
+ "operationId": "$searchExternalProductsRecommendation",
249
248
  "parameters": [
250
249
  {
251
250
  "in": "path",
package/dist/openapi.d.ts CHANGED
@@ -9071,6 +9071,10 @@ declare namespace Components {
9071
9071
  export interface SearchExternalCatalogParams {
9072
9072
  context: JourneyContext;
9073
9073
  }
9074
+ export interface SearchExternalCatalogRecommendationsResult {
9075
+ source: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem;
9076
+ offers: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
9077
+ }
9074
9078
  export interface SearchExternalCatalogResult {
9075
9079
  /**
9076
9080
  * The number of results returned.
@@ -9633,7 +9637,7 @@ declare namespace Paths {
9633
9637
  export type $400 = Components.Schemas.Error;
9634
9638
  }
9635
9639
  }
9636
- namespace $SearchExternalCatalog {
9640
+ namespace $SearchExternalProducts {
9637
9641
  namespace Parameters {
9638
9642
  export type IntegrationId = Components.Schemas.IntegrationId;
9639
9643
  }
@@ -9647,7 +9651,7 @@ declare namespace Paths {
9647
9651
  export type $403 = Components.Schemas.Error;
9648
9652
  }
9649
9653
  }
9650
- namespace $SearchExternalProducts {
9654
+ namespace $SearchExternalProductsRecommendation {
9651
9655
  namespace Parameters {
9652
9656
  export type IntegrationId = Components.Schemas.IntegrationId;
9653
9657
  }
@@ -9656,7 +9660,7 @@ declare namespace Paths {
9656
9660
  }
9657
9661
  export type RequestBody = Components.Schemas.SearchExternalCatalogParams;
9658
9662
  namespace Responses {
9659
- export type $200 = Components.Schemas.SearchExternalCatalogResult;
9663
+ export type $200 = Components.Schemas.SearchExternalCatalogRecommendationsResult;
9660
9664
  export type $400 = Components.Schemas.Error;
9661
9665
  export type $403 = Components.Schemas.Error;
9662
9666
  }
@@ -11011,16 +11015,6 @@ export interface OperationMethods {
11011
11015
  data?: any,
11012
11016
  config?: AxiosRequestConfig
11013
11017
  ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
11014
- /**
11015
- * $searchExternalCatalog - searchExternalCatalog
11016
- *
11017
- * Returns the list of available products (including computed prices) based on a given context.
11018
- */
11019
- '$searchExternalCatalog'(
11020
- parameters?: Parameters<Paths.$SearchExternalCatalog.PathParameters> | null,
11021
- data?: Paths.$SearchExternalCatalog.RequestBody,
11022
- config?: AxiosRequestConfig
11023
- ): OperationResponse<Paths.$SearchExternalCatalog.Responses.$200>
11024
11018
  /**
11025
11019
  * $searchExternalProducts - searchExternalProducts
11026
11020
  *
@@ -11031,6 +11025,16 @@ export interface OperationMethods {
11031
11025
  data?: Paths.$SearchExternalProducts.RequestBody,
11032
11026
  config?: AxiosRequestConfig
11033
11027
  ): OperationResponse<Paths.$SearchExternalProducts.Responses.$200>
11028
+ /**
11029
+ * $searchExternalProductsRecommendation - searchExternalProductsRecommendation
11030
+ *
11031
+ * Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.
11032
+ */
11033
+ '$searchExternalProductsRecommendation'(
11034
+ parameters?: Parameters<Paths.$SearchExternalProductsRecommendation.PathParameters> | null,
11035
+ data?: Paths.$SearchExternalProductsRecommendation.RequestBody,
11036
+ config?: AxiosRequestConfig
11037
+ ): OperationResponse<Paths.$SearchExternalProductsRecommendation.Responses.$200>
11034
11038
  /**
11035
11039
  * $searchProviders - searchProviders
11036
11040
  *
@@ -11247,18 +11251,6 @@ export interface PathsDictionary {
11247
11251
  config?: AxiosRequestConfig
11248
11252
  ): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
11249
11253
  }
11250
- ['/v1/public/integration/{integrationId}/external-catalog']: {
11251
- /**
11252
- * $searchExternalCatalog - searchExternalCatalog
11253
- *
11254
- * Returns the list of available products (including computed prices) based on a given context.
11255
- */
11256
- 'post'(
11257
- parameters?: Parameters<Paths.$SearchExternalCatalog.PathParameters> | null,
11258
- data?: Paths.$SearchExternalCatalog.RequestBody,
11259
- config?: AxiosRequestConfig
11260
- ): OperationResponse<Paths.$SearchExternalCatalog.Responses.$200>
11261
- }
11262
11254
  ['/v1/public/integration/{integrationId}/products']: {
11263
11255
  /**
11264
11256
  * $searchExternalProducts - searchExternalProducts
@@ -11271,6 +11263,18 @@ export interface PathsDictionary {
11271
11263
  config?: AxiosRequestConfig
11272
11264
  ): OperationResponse<Paths.$SearchExternalProducts.Responses.$200>
11273
11265
  }
11266
+ ['/v1/public/integration/{integrationId}/products-recommendation']: {
11267
+ /**
11268
+ * $searchExternalProductsRecommendation - searchExternalProductsRecommendation
11269
+ *
11270
+ * Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.
11271
+ */
11272
+ 'post'(
11273
+ parameters?: Parameters<Paths.$SearchExternalProductsRecommendation.PathParameters> | null,
11274
+ data?: Paths.$SearchExternalProductsRecommendation.RequestBody,
11275
+ config?: AxiosRequestConfig
11276
+ ): OperationResponse<Paths.$SearchExternalProductsRecommendation.Responses.$200>
11277
+ }
11274
11278
  ['/v1/public/integration/{integrationId}/providers:search']: {
11275
11279
  /**
11276
11280
  * $searchProviders - searchProviders
@@ -11472,6 +11476,7 @@ export type RedeemedPromo = Components.Schemas.RedeemedPromo;
11472
11476
  export type SalesTax = Components.Schemas.SalesTax;
11473
11477
  export type SaveIntegrationCredentialsParams = Components.Schemas.SaveIntegrationCredentialsParams;
11474
11478
  export type SearchExternalCatalogParams = Components.Schemas.SearchExternalCatalogParams;
11479
+ export type SearchExternalCatalogRecommendationsResult = Components.Schemas.SearchExternalCatalogRecommendationsResult;
11475
11480
  export type SearchExternalCatalogResult = Components.Schemas.SearchExternalCatalogResult;
11476
11481
  export type SearchProvidersParams = Components.Schemas.SearchProvidersParams;
11477
11482
  export type SearchProvidersResult = Components.Schemas.SearchProvidersResult;
package/dist/openapi.json CHANGED
@@ -1682,11 +1682,10 @@
1682
1682
  }
1683
1683
  }
1684
1684
  },
1685
- "/v1/public/integration/{integrationId}/external-catalog": {
1685
+ "/v1/public/integration/{integrationId}/products": {
1686
1686
  "post": {
1687
- "deprecated": true,
1688
- "description": "Returns the list of available products (including computed prices) based on a given context.",
1689
- "operationId": "$searchExternalCatalog",
1687
+ "description": "Returns the list of available products with computed prices based on a given context and for a given org integration.",
1688
+ "operationId": "$searchExternalProducts",
1690
1689
  "security": [
1691
1690
  {},
1692
1691
  {
@@ -1705,7 +1704,7 @@
1705
1704
  "example": "ikom"
1706
1705
  }
1707
1706
  ],
1708
- "summary": "searchExternalCatalog",
1707
+ "summary": "searchExternalProducts",
1709
1708
  "tags": [
1710
1709
  "External Integrations API"
1711
1710
  ],
@@ -1845,10 +1844,10 @@
1845
1844
  }
1846
1845
  }
1847
1846
  },
1848
- "/v1/public/integration/{integrationId}/products": {
1847
+ "/v1/public/integration/{integrationId}/products-recommendation": {
1849
1848
  "post": {
1850
- "description": "Returns the list of available products with computed prices based on a given context and for a given org integration.",
1851
- "operationId": "$searchExternalProducts",
1849
+ "description": "Returns the list of available products recommendation with computed prices based on a given context and for a given org integration.",
1850
+ "operationId": "$searchExternalProductsRecommendation",
1852
1851
  "security": [
1853
1852
  {},
1854
1853
  {
@@ -1864,10 +1863,10 @@
1864
1863
  "$ref": "#/components/schemas/IntegrationId"
1865
1864
  },
1866
1865
  "required": true,
1867
- "example": "ikom"
1866
+ "example": "external-catalog"
1868
1867
  }
1869
1868
  ],
1870
- "summary": "searchExternalProducts",
1869
+ "summary": "searchExternalProductsRecommendation",
1871
1870
  "tags": [
1872
1871
  "External Integrations API"
1873
1872
  ],
@@ -1877,6 +1876,33 @@
1877
1876
  "application/json": {
1878
1877
  "schema": {
1879
1878
  "$ref": "#/components/schemas/SearchExternalCatalogParams"
1879
+ },
1880
+ "examples": {
1881
+ "Search recommendations": {
1882
+ "value": {
1883
+ "context": {
1884
+ "journey_id": "8d0a2235-97ce-42d0-88a3-e374634ca44e",
1885
+ "journey_name": "Energy Provider Selection",
1886
+ "current_step_name": "product-selection",
1887
+ "current_block_name": "recommendations-block",
1888
+ "steps_data": [
1889
+ {
1890
+ "step_name": "address",
1891
+ "step_index": 1,
1892
+ "blocks": {
1893
+ "Adresse": {
1894
+ "countryCode": "DE",
1895
+ "city": "Koblenz",
1896
+ "zipCode": "56068",
1897
+ "streetName": "Am Alten Hospital",
1898
+ "houseNumber": "123"
1899
+ }
1900
+ }
1901
+ }
1902
+ ]
1903
+ }
1904
+ }
1905
+ }
1880
1906
  }
1881
1907
  }
1882
1908
  }
@@ -1887,94 +1913,277 @@
1887
1913
  "content": {
1888
1914
  "application/json": {
1889
1915
  "schema": {
1890
- "$ref": "#/components/schemas/SearchExternalCatalogResult"
1916
+ "$ref": "#/components/schemas/SearchExternalCatalogRecommendationsResult"
1891
1917
  },
1892
1918
  "examples": {
1893
- "External products": {
1919
+ "External catalog recommendations": {
1894
1920
  "value": {
1895
- "hits": 1,
1896
- "results": [
1897
- {
1898
- "pricing_details": {
1899
- "items": [
1900
- {
1901
- "_id": "price-12312414",
1902
- "price_id": "price-12312414",
1903
- "is_composite_price": true,
1904
- "description": "Home Energy Package Composite",
1905
- "item_components": [
1906
- {
1921
+ "source": {
1922
+ "pricing_details": {
1923
+ "items": [
1924
+ {
1925
+ "_id": "price-12312414",
1926
+ "price_id": "price-12312414",
1927
+ "product_id": "product-12312414",
1928
+ "is_composite_price": true,
1929
+ "description": "Home Energy Package Composite",
1930
+ "item_components": [
1931
+ {
1932
+ "_id": "price-12312414-component-0",
1933
+ "price_id": "price-12312414-component-0",
1934
+ "product_id": "product-12312414",
1935
+ "description": "Working Price",
1936
+ "is_tax_inclusive": true,
1937
+ "amount_total_decimal": "50",
1938
+ "amount_total": 5000,
1939
+ "amount_subtotal_decimal": "50",
1940
+ "amount_subtotal": 5000,
1941
+ "unit_amount": 5,
1942
+ "unit_amount_gross": 5,
1943
+ "unit_amount_gross_decimal": "0.05",
1944
+ "unit_amount_net": 5,
1945
+ "unit_amount_net_decimal": "0.05",
1946
+ "billing_period": "monthly",
1947
+ "type": "recurring",
1948
+ "taxes": [],
1949
+ "pricing_model": "per_unit",
1950
+ "quantity": 1,
1951
+ "_price": {
1907
1952
  "_id": "price-12312414-component-0",
1908
- "price_id": "price-12312414-component-0",
1953
+ "unit_amount_currency": "EUR",
1909
1954
  "description": "Working Price",
1910
1955
  "is_tax_inclusive": true,
1911
- "amount_total_decimal": "100",
1912
- "amount_total": 10000,
1913
- "amount_subtotal_decimal": "100",
1914
- "amount_subtotal": 10000,
1915
- "unit_amount": 10,
1916
- "unit_amount_gross": 10,
1917
- "unit_amount_gross_decimal": "0.10",
1918
- "unit_amount_net": 10,
1919
- "unit_amount_net_decimal": "0.10",
1956
+ "unit_amount": 5,
1957
+ "unit_amount_decimal": "0.05",
1958
+ "unit": "kWh",
1920
1959
  "billing_period": "monthly",
1921
1960
  "type": "recurring",
1922
- "taxes": [],
1961
+ "billing_duration_amount": 24,
1962
+ "billing_duration_unit": "months",
1963
+ "notice_time_amount": 3,
1964
+ "notice_time_unit": "months",
1965
+ "termination_time_amount": 3,
1966
+ "termination_time_unit": "months",
1967
+ "renewal_duration_amount": 12,
1968
+ "renewal_duration_unit": "months",
1969
+ "active": true,
1970
+ "is_composite_price": false,
1971
+ "variable_price": true,
1923
1972
  "pricing_model": "per_unit",
1924
- "quantity": 1,
1925
- "_price": {
1926
- "_id": "price-12312414-component-0",
1927
- "unit_amount_currency": "EUR",
1928
- "description": "Working Price",
1929
- "is_tax_inclusive": true,
1930
- "unit_amount": 10,
1931
- "unit_amount_decimal": "0.10",
1932
- "unit": "kWh",
1933
- "billing_period": "monthly",
1934
- "type": "recurring",
1935
- "billing_duration_amount": 24,
1936
- "billing_duration_unit": "months",
1937
- "notice_time_amount": 3,
1938
- "notice_time_unit": "months",
1939
- "termination_time_amount": 3,
1940
- "termination_time_unit": "months",
1941
- "renewal_duration_amount": 12,
1942
- "renewal_duration_unit": "months",
1943
- "active": true,
1944
- "is_composite_price": false,
1945
- "variable_price": true,
1946
- "pricing_model": "per_unit",
1947
- "price_display_in_journeys": "show_price"
1948
- }
1973
+ "price_display_in_journeys": "show_price"
1974
+ },
1975
+ "_product": {
1976
+ "_id": "product-12312414",
1977
+ "name": "Home Energy Package",
1978
+ "description": "Composite home energy solution with solar panels and battery"
1949
1979
  }
1950
- ]
1951
- }
1952
- ],
1953
- "currency": "EUR",
1954
- "amount_subtotal": 10000,
1955
- "amount_total": 10000,
1980
+ }
1981
+ ]
1982
+ }
1983
+ ],
1984
+ "currency": "EUR",
1985
+ "amount_subtotal": 5000,
1986
+ "amount_total": 5000,
1987
+ "amount_tax": 0,
1988
+ "total_details": {
1956
1989
  "amount_tax": 0,
1957
- "total_details": {
1958
- "amount_tax": 0,
1959
- "breakdown": {
1990
+ "breakdown": {
1991
+ "taxes": [],
1992
+ "recurrences": [
1993
+ {
1994
+ "type": "recurring",
1995
+ "billing_period": "monthly",
1996
+ "amount_total": 5000,
1997
+ "amount_total_decimal": "50.00",
1998
+ "amount_subtotal": 5000,
1999
+ "amount_subtotal_decimal": "50.00",
2000
+ "amount_tax": 0
2001
+ }
2002
+ ]
2003
+ }
2004
+ }
2005
+ },
2006
+ "_meta": {
2007
+ "signature": "abc123",
2008
+ "timestamp": 1712049221642
2009
+ }
2010
+ },
2011
+ "offers": [
2012
+ {
2013
+ "pricing_details": {
2014
+ "items": [
2015
+ {
2016
+ "_id": "price-999857a4",
2017
+ "price_id": "price-999857a4",
2018
+ "product_id": "product-999857a4",
2019
+ "is_composite_price": false,
2020
+ "description": "Single Price",
2021
+ "is_tax_inclusive": true,
2022
+ "amount_total_decimal": "25",
2023
+ "amount_total": 2500,
2024
+ "amount_subtotal_decimal": "25",
2025
+ "amount_subtotal": 2500,
2026
+ "unit_amount": 25,
2027
+ "unit_amount_gross": 25,
2028
+ "unit_amount_gross_decimal": "25",
2029
+ "unit_amount_net": 25,
2030
+ "unit_amount_net_decimal": "25",
2031
+ "billing_period": null,
2032
+ "type": "one_time",
1960
2033
  "taxes": [],
1961
- "recurrences": [
2034
+ "pricing_model": "per_unit",
2035
+ "quantity": 1,
2036
+ "_price": {
2037
+ "_id": "price-999857a4",
2038
+ "unit_amount_currency": "EUR",
2039
+ "description": "Single Price",
2040
+ "is_tax_inclusive": true,
2041
+ "unit_amount": 25,
2042
+ "unit_amount_decimal": "25",
2043
+ "billing_duration_amount": 24,
2044
+ "billing_duration_unit": "months",
2045
+ "notice_time_amount": 3,
2046
+ "notice_time_unit": "months",
2047
+ "termination_time_amount": 3,
2048
+ "termination_time_unit": "months",
2049
+ "renewal_duration_amount": 12,
2050
+ "renewal_duration_unit": "months",
2051
+ "active": true,
2052
+ "is_composite_price": false,
2053
+ "pricing_model": "per_unit",
2054
+ "price_display_in_journeys": "show_price"
2055
+ },
2056
+ "_product": {
2057
+ "_id": "product-999857a4",
2058
+ "name": "Solar Panel X2",
2059
+ "description": "High-efficiency solar panel for residential use"
2060
+ }
2061
+ }
2062
+ ]
2063
+ },
2064
+ "currency": "EUR",
2065
+ "amount_subtotal": 2500,
2066
+ "amount_total": 2500,
2067
+ "amount_tax": 0,
2068
+ "total_details": {
2069
+ "amount_tax": 0,
2070
+ "breakdown": {
2071
+ "taxes": [],
2072
+ "recurrences": [
2073
+ {
2074
+ "type": "one_time",
2075
+ "amount_total": 2500,
2076
+ "amount_total_decimal": "25.00",
2077
+ "amount_subtotal": 2500,
2078
+ "amount_subtotal_decimal": "25.00",
2079
+ "amount_tax": 0
2080
+ }
2081
+ ]
2082
+ }
2083
+ },
2084
+ "_meta": {
2085
+ "signature": "def456",
2086
+ "timestamp": 1712049221643
2087
+ }
2088
+ },
2089
+ {
2090
+ "pricing_details": {
2091
+ "items": [
2092
+ {
2093
+ "_id": "price-93f857a4",
2094
+ "price_id": "price-93f857a4",
2095
+ "product_id": "product-93f857a4",
2096
+ "is_composite_price": false,
2097
+ "description": "Single Price",
2098
+ "is_tax_inclusive": false,
2099
+ "amount_total_decimal": "29.75",
2100
+ "amount_total": 2975,
2101
+ "amount_subtotal_decimal": "25",
2102
+ "amount_subtotal": 2500,
2103
+ "unit_amount": 25,
2104
+ "unit_amount_gross": 29.75,
2105
+ "unit_amount_gross_decimal": "29.75",
2106
+ "unit_amount_net": 25,
2107
+ "unit_amount_net_decimal": "25",
2108
+ "billing_period": null,
2109
+ "type": "one_time",
2110
+ "taxes": [
1962
2111
  {
1963
- "type": "recurring",
1964
- "billing_period": "monthly",
1965
- "amount_total": 10000,
1966
- "amount_total_decimal": "100.00",
1967
- "amount_subtotal": 10000,
1968
- "amount_subtotal_decimal": "100.00",
1969
- "amount_tax": 0
2112
+ "tax": {
2113
+ "_id": "tax-vat-19",
2114
+ "name": "VAT",
2115
+ "type": "VAT",
2116
+ "rate": 19,
2117
+ "region": "DE"
2118
+ },
2119
+ "amount": 475
1970
2120
  }
1971
- ]
2121
+ ],
2122
+ "pricing_model": "per_unit",
2123
+ "quantity": 1,
2124
+ "_price": {
2125
+ "_id": "price-93f857a4",
2126
+ "unit_amount_currency": "EUR",
2127
+ "description": "Single Price",
2128
+ "is_tax_inclusive": false,
2129
+ "unit_amount": 25,
2130
+ "unit_amount_decimal": "25",
2131
+ "active": true,
2132
+ "is_composite_price": false,
2133
+ "pricing_model": "per_unit",
2134
+ "price_display_in_journeys": "show_price",
2135
+ "tax": [
2136
+ {
2137
+ "_id": "tax-vat-19",
2138
+ "name": "VAT",
2139
+ "type": "VAT",
2140
+ "rate": 19,
2141
+ "region": "DE"
2142
+ }
2143
+ ]
2144
+ },
2145
+ "_product": {
2146
+ "_id": "product-93f857a4",
2147
+ "name": "Solar Panel X3",
2148
+ "description": "New generation of high-efficiency solar panel for residential use"
2149
+ }
1972
2150
  }
2151
+ ]
2152
+ },
2153
+ "currency": "EUR",
2154
+ "amount_subtotal": 2500,
2155
+ "amount_total": 2975,
2156
+ "amount_tax": 475,
2157
+ "total_details": {
2158
+ "amount_tax": 475,
2159
+ "breakdown": {
2160
+ "taxes": [
2161
+ {
2162
+ "tax": {
2163
+ "_id": "tax-vat-19",
2164
+ "name": "VAT",
2165
+ "type": "VAT",
2166
+ "rate": 19,
2167
+ "region": "DE"
2168
+ },
2169
+ "amount": 475
2170
+ }
2171
+ ],
2172
+ "recurrences": [
2173
+ {
2174
+ "type": "one_time",
2175
+ "amount_total": 2975,
2176
+ "amount_total_decimal": "29.75",
2177
+ "amount_subtotal": 2500,
2178
+ "amount_subtotal_decimal": "25.00",
2179
+ "amount_tax": 475
2180
+ }
2181
+ ]
1973
2182
  }
1974
2183
  },
1975
2184
  "_meta": {
1976
- "signature": "abc123",
1977
- "timestamp": 1712049221642
2185
+ "signature": "ghi789",
2186
+ "timestamp": 1712049221644
1978
2187
  }
1979
2188
  }
1980
2189
  ]
@@ -8179,6 +8388,24 @@
8179
8388
  "hits"
8180
8389
  ]
8181
8390
  },
8391
+ "SearchExternalCatalogRecommendationsResult": {
8392
+ "type": "object",
8393
+ "properties": {
8394
+ "source": {
8395
+ "$ref": "#/components/schemas/ExternalCatalogItem"
8396
+ },
8397
+ "offers": {
8398
+ "type": "array",
8399
+ "items": {
8400
+ "$ref": "#/components/schemas/ExternalCatalogItem"
8401
+ }
8402
+ }
8403
+ },
8404
+ "required": [
8405
+ "source",
8406
+ "offers"
8407
+ ]
8408
+ },
8182
8409
  "ExternalCatalogItem": {
8183
8410
  "type": "object",
8184
8411
  "description": "An external product & price information (already computed) from an external catalog.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.51.1",
3
+ "version": "3.51.2",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",