npm - @epilot/pricing-client - Versions diffs - 3.47.10 → 3.47.12 - Mend

@epilot/pricing-client 3.47.10 → 3.47.12

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 (3) hide show

package/dist/openapi.d.ts CHANGED Viewed

@@ -4979,6 +4979,10 @@ declare namespace Components {
                  */
                 price_id?: string;
             };
+            /**
+             * The contract id to be used as source for the recommendation
+             */
+            contract_id?: string;
         }
         /**
          * example:
@@ -5959,6 +5963,16 @@ export interface OperationMethods {
     data?: Paths.$CheckoutCart.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
+  /**
+   * $productRecommendations - productRecommendations
+   *
+   * Get a list of product recommendations based on the search parameters.
+   */
+  '$productRecommendations'(
+    parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
+    data?: Paths.$ProductRecommendations.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
   /**
    * $searchCatalog - searchCatalog
    *
@@ -6099,16 +6113,6 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
-  /**
-   * $productRecommendations - productRecommendations
-   *
-   * Get a list of product recommendations based on the search parameters.
-   */
-  '$productRecommendations'(
-    parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
-    data?: Paths.$ProductRecommendations.RequestBody,
-    config?: AxiosRequestConfig
-  ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
 }
 export interface PathsDictionary {
@@ -6171,6 +6175,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.$CheckoutCart.Responses.$200>
   }
+  ['/v1/public/product-recommendations']: {
+    /**
+     * $productRecommendations - productRecommendations
+     *
+     * Get a list of product recommendations based on the search parameters.
+     */
+    'post'(
+      parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
+      data?: Paths.$ProductRecommendations.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
+  }
   ['/v1/public/catalog']: {
     /**
      * $searchCatalog - searchCatalog
@@ -6339,18 +6355,6 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
   }
-  ['/v1/public/product-recommendations']: {
-    /**
-     * $productRecommendations - productRecommendations
-     *
-     * Get a list of product recommendations based on the search parameters.
-     */
-    'post'(
-      parameters?: Parameters<Paths.$ProductRecommendations.HeaderParameters> | null,
-      data?: Paths.$ProductRecommendations.RequestBody,
-      config?: AxiosRequestConfig
-    ): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
-  }
 }
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json CHANGED Viewed

@@ -1037,6 +1037,138 @@
         }
       }
     },
+    "/v1/public/product-recommendations": {
+      "post": {
+        "description": "Get a list of product recommendations based on the search parameters.",
+        "operationId": "$productRecommendations",
+        "summary": "productRecommendations",
+        "security": [
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
+        "tags": [
+          "Product Recommendations API"
+        ],
+        "parameters": [
+          {
+            "in": "header",
+            "name": "X-Ivy-Org-ID",
+            "description": "The target Organization Id represented by the caller",
+            "example": 739224,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ProductRecommendationSearch"
+              },
+              "examples": {
+                "Search product recommendations by id": {
+                  "value": {
+                    "product_recommendation_ids": [
+                      "bae8d40a-0093-483a-b4f9-3653800b6781"
+                    ]
+                  }
+                },
+                "Search product recommendations by source product and price": {
+                  "value": {
+                    "catalog_item": {
+                      "product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
+                      "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
+                    }
+                  }
+                },
+                "Search product recommendations by contract": {
+                  "value": {
+                    "contract_id": "98ffca40-46ab-4288-af10-a478893b2aa2"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The product recommendations result",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ProductRecommendationResponse"
+                },
+                "examples": {
+                  "Product recommendations": {
+                    "value": {
+                      "hits": 1,
+                      "results": [
+                        {
+                          "_title": "Tarifwechsel 2025",
+                          "_created_at": "2025-01-29T15:46:41.014Z",
+                          "_updated_at": "2025-01-29T15:46:41.014Z",
+                          "name": "Tarifwechsel 2025",
+                          "type": "change",
+                          "source_product": {
+                            "$relation": [
+                              {
+                                "entity_id": "e2b12b54-d904-42b7-ac44-802d8ebaadf4"
+                              }
+                            ]
+                          },
+                          "source_price": {
+                            "$relation": [
+                              {
+                                "entity_id": "255877f3-f9c2-483e-9c71-89088c142bfc"
+                              }
+                            ]
+                          },
+                          "_schema": "product_recommendation",
+                          "offers": [
+                            {
+                              "target_id": "f9aa8757-505b-46bd-9310-605d64849565",
+                              "items": [
+                                {
+                                  "product_id": "70ad8a08-46c2-473b-b1c5-8bccfb85e452",
+                                  "price_id": "26c9c39d-db4a-4132-af2e-86ab5c7b156c"
+                                },
+                                {
+                                  "product_id": "dd97a2a4-e48b-43c5-8717-7ac563c67e05",
+                                  "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
+                                },
+                                {
+                                  "product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
+                                  "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
+                                }
+                              ]
+                            }
+                          ],
+                          "_id": "6d872912-ef8a-4815-b9db-01744c0828ac",
+                          "_org": "739224"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/public/catalog": {
       "post": {
         "description": "Provides a querying functionalities over products and prices of the Catalog for a given organization.",
@@ -2211,133 +2343,6 @@
           }
         }
       }
-    },
-    "/v1/public/product-recommendations": {
-      "post": {
-        "description": "Get a list of product recommendations based on the search parameters.",
-        "operationId": "$productRecommendations",
-        "summary": "productRecommendations",
-        "security": [
-          {
-            "EpilotPublicAuth": []
-          }
-        ],
-        "tags": [
-          "Product Recommendations API"
-        ],
-        "parameters": [
-          {
-            "in": "header",
-            "name": "X-Ivy-Org-ID",
-            "description": "The target Organization Id represented by the caller",
-            "example": 739224,
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/ProductRecommendationSearch"
-              },
-              "examples": {
-                "Search product recommendations by id": {
-                  "value": {
-                    "product_recommendation_ids": [
-                      "bae8d40a-0093-483a-b4f9-3653800b6781"
-                    ]
-                  }
-                },
-                "Search product recommendations source product and price": {
-                  "value": {
-                    "catalog_item": {
-                      "product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
-                      "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
-                    }
-                  }
-                }
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "The product recommendations result",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ProductRecommendationResponse"
-                },
-                "examples": {
-                  "Product recommendations": {
-                    "value": {
-                      "hits": 1,
-                      "results": [
-                        {
-                          "_title": "Tarifwechsel 2025",
-                          "_created_at": "2025-01-29T15:46:41.014Z",
-                          "_updated_at": "2025-01-29T15:46:41.014Z",
-                          "name": "Tarifwechsel 2025",
-                          "type": "change",
-                          "source_product": {
-                            "$relation": [
-                              {
-                                "entity_id": "e2b12b54-d904-42b7-ac44-802d8ebaadf4"
-                              }
-                            ]
-                          },
-                          "source_price": {
-                            "$relation": [
-                              {
-                                "entity_id": "255877f3-f9c2-483e-9c71-89088c142bfc"
-                              }
-                            ]
-                          },
-                          "_schema": "product_recommendation",
-                          "offers": [
-                            {
-                              "target_id": "f9aa8757-505b-46bd-9310-605d64849565",
-                              "items": [
-                                {
-                                  "product_id": "70ad8a08-46c2-473b-b1c5-8bccfb85e452",
-                                  "price_id": "26c9c39d-db4a-4132-af2e-86ab5c7b156c"
-                                },
-                                {
-                                  "product_id": "dd97a2a4-e48b-43c5-8717-7ac563c67e05",
-                                  "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
-                                },
-                                {
-                                  "product_id": "aa1ebf85-f36e-46ff-978c-ed948c646f12",
-                                  "price_id": "4ecf9a61-a974-4594-bae2-bcb798f54d76"
-                                }
-                              ]
-                            }
-                          ],
-                          "_id": "6d872912-ef8a-4815-b9db-01744c0828ac",
-                          "_org": "739224"
-                        }
-                      ]
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid payload",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Error"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {
@@ -6807,6 +6812,10 @@
                 "description": "Product id"
               }
             }
+          },
+          "contract_id": {
+            "type": "string",
+            "description": "The contract id to be used as source for the recommendation"
           }
         }
       },

package/package.json CHANGED Viewed

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