@epilot/pricing-client 3.47.9-alpha.5 → 3.47.9-alpha.6

package/dist/openapi.d.ts

@@ -1086,14 +1086,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -1375,30 +1370,7 @@ declare namespace Components {
              * The coupon entity
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
             Coupon)[];
@@ -1954,14 +1926,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -2233,30 +2200,7 @@ declare namespace Components {
          * The coupon entity
          * example:
          * {
-         *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "_schema": "coupon",
-         *   "_org": "org_12345",
-         *   "_created_at": "2024-01-15T10:00:00.000Z",
-         *   "_updated_at": "2024-01-20T12:00:00.000Z",
-         *   "_title": "Sample Coupon",
-         *   "name": "Sample Coupon",
-         *   "type": "fixed",
-         *   "fixed_value": 555,
-         *   "fixed_value_currency": "USD",
-         *   "fixed_value_decimal": "5.55",
-         *   "active": true,
-         *   "prices": {
-         *     "$relation": [
-         *       {
-         *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-         *         "_tags": [
-         *           "discount",
-         *           "special"
-         *         ],
-         *         "_schema": "price"
-         *       }
-         *     ]
-         *   }
+         *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
          * }
          */
         export interface Coupon {
@@ -2335,10 +2279,7 @@ declare namespace Components {
             promo_codes?: /**
              * example:
              * {
-             *   "id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "code": "123456",
-             *   "has_usage_limit": true,
-             *   "usage_limit": 10
+             *   "$ref": "#/components/examples/promo-code/value"
              * }
              */
             PromoCode[];
@@ -2417,30 +2358,7 @@ declare namespace Components {
          * The base for the coupon entity without promo codes
          * example:
          * {
-         *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "_schema": "coupon",
-         *   "_org": "org_12345",
-         *   "_created_at": "2024-01-15T10:00:00.000Z",
-         *   "_updated_at": "2024-01-20T12:00:00.000Z",
-         *   "_title": "Sample Coupon",
-         *   "name": "Sample Coupon",
-         *   "type": "fixed",
-         *   "fixed_value": 555,
-         *   "fixed_value_currency": "USD",
-         *   "fixed_value_decimal": "5.55",
-         *   "active": true,
-         *   "prices": {
-         *     "$relation": [
-         *       {
-         *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-         *         "_tags": [
-         *           "discount",
-         *           "special"
-         *         ],
-         *         "_schema": "price"
-         *       }
-         *     ]
-         *   }
+         *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
          * }
          */
         export interface CouponWithoutPromoCodes {
@@ -2548,15 +2466,7 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-         *   "_org": "123",
-         *   "_schema": "contact",
-         *   "_tags": [
-         *     "example",
-         *     "mock"
-         *   ],
-         *   "_created_at": "2021-02-09T12:41:43.662Z",
-         *   "_updated_at": "2021-02-09T12:41:43.662Z"
+         *   "$ref": "#/components/examples/entity-item/value"
          * }
          */
         export interface EntityItem {
@@ -2603,10 +2513,7 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "amount_total": 1000,
-         *   "amount_total_decimal": "10.00"
+         *   "$ref": "#/components/examples/external-fee-mapping/value"
          * }
          */
         export interface ExternalFeeMapping {
@@ -2617,22 +2524,14 @@ declare namespace Components {
         }
         /**
          * example:
-         * [
-         *   {
-         *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *     "frequency_unit": "weekly",
-         *     "amount_total": 1000,
-         *     "amount_total_decimal": "10.00"
-         *   }
-         * ]
+         * {
+         *   "$ref": "#/components/examples/external-fee-mappings/value"
+         * }
          */
         export type ExternalFeeMappings = /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "amount_total": 1000,
-         *   "amount_total_decimal": "10.00"
+         *   "$ref": "#/components/examples/external-fee-mapping/value"
          * }
          */
         ExternalFeeMapping[];
@@ -3126,6 +3025,11 @@ declare namespace Components {
              */
             base_url?: string;
         }
+        export interface Offer {
+            product_id?: string;
+            price_id?: string;
+            target_id?: string;
+        }
         /**
          * The opportunity entity
          * example:
@@ -3652,20 +3556,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax[];
@@ -3867,14 +3758,7 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "value": 1000.245,
-         *   "name": "avg consumption",
-         *   "metadata": {
-         *     "journey_title": "energy journey",
-         *     "step_name": "avg consumption picker"
-         *   }
+         *   "$ref": "#/components/examples/price-input-mapping/value"
          * }
          */
         export interface PriceInputMapping {
@@ -3904,14 +3788,7 @@ declare namespace Components {
         export type PriceInputMappings = /**
          * example:
          * {
-         *   "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-         *   "frequency_unit": "weekly",
-         *   "value": 1000.245,
-         *   "name": "avg consumption",
-         *   "metadata": {
-         *     "journey_title": "energy journey",
-         *     "step_name": "avg consumption picker"
-         *   }
+         *   "$ref": "#/components/examples/price-input-mapping/value"
          * }
          */
         PriceInputMapping[];
@@ -4266,7 +4143,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             pricing_model: /**
              * Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.
              * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
@@ -4433,14 +4310,9 @@ declare namespace Components {
             };
             external_fees_mappings?: /**
              * example:
-             * [
-             *   {
-             *     "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-             *     "frequency_unit": "weekly",
-             *     "amount_total": 1000,
-             *     "amount_total_decimal": "10.00"
-             *   }
-             * ]
+             * {
+             *   "$ref": "#/components/examples/external-fee-mappings/value"
+             * }
              */
             ExternalFeeMappings;
             external_fees_metadata?: ExternalFeeMetadata;
@@ -4469,7 +4341,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit amount value
              */
@@ -4598,20 +4470,7 @@ declare namespace Components {
                  * the tax configuration
                  * example:
                  * {
-                 *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-                 *   "type": "VAT",
-                 *   "description": "Tax description",
-                 *   "active": "true",
-                 *   "region": "DE",
-                 *   "region_label": "Germany",
-                 *   "_org": "123",
-                 *   "_schema": "tax",
-                 *   "_tags": [
-                 *     "example",
-                 *     "mock"
-                 *   ],
-                 *   "_created_at": "2021-02-09T12:41:43.662Z",
-                 *   "_updated_at": "2021-02-09T12:41:43.662Z"
+                 *   "$ref": "#/components/examples/tax/value"
                  * }
                  */
                 Tax[];
@@ -4945,10 +4804,80 @@ declare namespace Components {
         /**
          * example:
          * {
-         *   "id": "123e4567-e89b-12d3-a456-426614174000",
-         *   "code": "123456",
-         *   "has_usage_limit": true,
-         *   "usage_limit": 10
+         *   "$ref": "#/components/examples/entity-item/value"
+         * }
+         */
+        export interface ProductRecommendation {
+            _id: EntityId /* uuid */;
+            /**
+             * Title of entity
+             */
+            _title: string;
+            /**
+             * Organization Id the entity belongs to
+             */
+            _org: string;
+            _schema: string;
+            _tags?: string[];
+            _created_at: string; // date-time
+            _updated_at: string; // date-time
+            /**
+             * Price being used as source
+             */
+            source_price?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Product being used as source
+             */
+            source_product?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Type of product recommendation
+             */
+            type?: "change" | "cross-sell" | "up-sell";
+            offer?: Offer[];
+        }
+        /**
+         * Product recommendations request payload
+         */
+        export interface ProductRecommendationResponse {
+            /**
+             * The number os results returned.
+             */
+            hits?: number;
+            results?: /**
+             * example:
+             * {
+             *   "$ref": "#/components/examples/entity-item/value"
+             * }
+             */
+            ProductRecommendation[];
+        }
+        /**
+         * Product recommendations request payload
+         */
+        export interface ProductRecommendationSearch {
+            product_recommendation_ids?: string[];
+            /**
+             * The catalog item to be used as source for the recommendation
+             */
+            catalog_item?: {
+                /**
+                 * Product id
+                 */
+                product_id?: string;
+                /**
+                 * Product id
+                 */
+                price_id?: string;
+            };
+        }
+        /**
+         * example:
+         * {
+         *   "$ref": "#/components/examples/promo-code/value"
          * }
          */
         export interface PromoCode {
@@ -4977,30 +4906,7 @@ declare namespace Components {
              * The base for the coupon entity without promo codes
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
             CouponWithoutPromoCodes[];
@@ -5085,7 +4991,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit gross amount value.
              */
@@ -5178,7 +5084,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * The unit gross amount value.
              */
@@ -5203,7 +5109,7 @@ declare namespace Components {
             /**
              * The price billing period.
              */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+            billing_period?: /* The price billing period. */ BillingPeriod;
             /**
              * Total amount of items with same recurrence.
              */
@@ -5235,30 +5141,7 @@ declare namespace Components {
              * The base for the coupon entity without promo codes
              * example:
              * {
-             *   "_id": "123e4567-e89b-12d3-a456-426614174000",
-             *   "_schema": "coupon",
-             *   "_org": "org_12345",
-             *   "_created_at": "2024-01-15T10:00:00.000Z",
-             *   "_updated_at": "2024-01-20T12:00:00.000Z",
-             *   "_title": "Sample Coupon",
-             *   "name": "Sample Coupon",
-             *   "type": "fixed",
-             *   "fixed_value": 555,
-             *   "fixed_value_currency": "USD",
-             *   "fixed_value_decimal": "5.55",
-             *   "active": true,
-             *   "prices": {
-             *     "$relation": [
-             *       {
-             *         "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-             *         "_tags": [
-             *           "discount",
-             *           "special"
-             *         ],
-             *         "_schema": "price"
-             *       }
-             *     ]
-             *   }
+             *   "$ref": "#/components/examples/coupon-without-promo-codes/value"
              * }
              */
             CouponWithoutPromoCodes[];
@@ -5360,20 +5243,7 @@ declare namespace Components {
          * the tax configuration
          * example:
          * {
-         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-         *   "type": "VAT",
-         *   "description": "Tax description",
-         *   "active": "true",
-         *   "region": "DE",
-         *   "region_label": "Germany",
-         *   "_org": "123",
-         *   "_schema": "tax",
-         *   "_tags": [
-         *     "example",
-         *     "mock"
-         *   ],
-         *   "_created_at": "2021-02-09T12:41:43.662Z",
-         *   "_updated_at": "2021-02-09T12:41:43.662Z"
+         *   "$ref": "#/components/examples/tax/value"
          * }
          */
         export interface Tax {
@@ -5425,20 +5295,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax;
@@ -5475,20 +5332,7 @@ declare namespace Components {
              * the tax configuration
              * example:
              * {
-             *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-             *   "type": "VAT",
-             *   "description": "Tax description",
-             *   "active": "true",
-             *   "region": "DE",
-             *   "region_label": "Germany",
-             *   "_org": "123",
-             *   "_schema": "tax",
-             *   "_tags": [
-             *     "example",
-             *     "mock"
-             *   ],
-             *   "_created_at": "2021-02-09T12:41:43.662Z",
-             *   "_updated_at": "2021-02-09T12:41:43.662Z"
+             *   "$ref": "#/components/examples/tax/value"
              * }
              */
             Tax;
@@ -5758,6 +5602,19 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $ProductRecommendations {
+        export interface HeaderParameters {
+            "X-Ivy-Org-ID"?: Parameters.XIvyOrgID;
+        }
+        namespace Parameters {
+            export type XIvyOrgID = string;
+        }
+        export type RequestBody = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationSearch;
+        namespace Responses {
+            export type $200 = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationResponse;
+            export type $400 = Components.Schemas.Error;
+        }
+    }
     namespace $SaveCredentials {
         namespace Parameters {
             export type IntegrationId = Components.Schemas.IntegrationId;
@@ -6142,6 +5999,16 @@ 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 {
@@ -6372,6 +6239,18 @@ 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>
@@ -6444,6 +6323,7 @@ export type MetaData = Components.Schemas.MetaData;
 export type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice;
 export type OAuthCredentials = Components.Schemas.OAuthCredentials;
 export type OAuthIntegration = Components.Schemas.OAuthIntegration;
+export type Offer = Components.Schemas.Offer;
 export type Opportunity = Components.Schemas.Opportunity;
 export type OpportunitySource = Components.Schemas.OpportunitySource;
 export type Order = Components.Schemas.Order;
@@ -6473,6 +6353,9 @@ export type PricingDetailsResponse = Components.Schemas.PricingDetailsResponse;
 export type PricingModel = Components.Schemas.PricingModel;
 export type Product = Components.Schemas.Product;
 export type ProductCategory = Components.Schemas.ProductCategory;
+export type ProductRecommendation = Components.Schemas.ProductRecommendation;
+export type ProductRecommendationResponse = Components.Schemas.ProductRecommendationResponse;
+export type ProductRecommendationSearch = Components.Schemas.ProductRecommendationSearch;
 export type PromoCode = Components.Schemas.PromoCode;
 export type PromoCodeValidationResponse = Components.Schemas.PromoCodeValidationResponse;
 export type Provider = Components.Schemas.Provider;

package/dist/openapi.json

@@ -2211,6 +2211,133 @@
           }
         }
       }
+    },
+    "/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": {
@@ -3254,14 +3381,7 @@
           }
         },
         "example": {
-          "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-          "frequency_unit": "weekly",
-          "value": 1000.245,
-          "name": "avg consumption",
-          "metadata": {
-            "journey_title": "energy journey",
-            "step_name": "avg consumption picker"
-          }
+          "$ref": "#/components/examples/price-input-mapping/value"
         }
       },
       "PriceConditions": {
@@ -3354,14 +3474,9 @@
         "items": {
           "$ref": "#/components/schemas/ExternalFeeMapping"
         },
-        "example": [
-          {
-            "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-            "frequency_unit": "weekly",
-            "amount_total": 1000,
-            "amount_total_decimal": "10.00"
-          }
-        ]
+        "example": {
+          "$ref": "#/components/examples/external-fee-mappings/value"
+        }
       },
       "ExternalFeeMapping": {
         "type": "object",
@@ -3388,10 +3503,7 @@
           }
         },
         "example": {
-          "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
-          "frequency_unit": "weekly",
-          "amount_total": 1000,
-          "amount_total_decimal": "10.00"
+          "$ref": "#/components/examples/external-fee-mapping/value"
         }
       },
       "CatalogSearch": {
@@ -4562,14 +4674,11 @@
                 ]
               },
               "billing_period": {
-                "type": "string",
                 "description": "The price billing period.",
-                "enum": [
-                  "weekly",
-                  "monthly",
-                  "every_quarter",
-                  "every_6_months",
-                  "yearly"
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/BillingPeriod"
+                  }
                 ]
               },
               "unit_amount": {
@@ -4731,14 +4840,11 @@
             "description": "The price type."
           },
           "billing_period": {
-            "type": "string",
             "description": "The price billing period.",
-            "enum": [
-              "weekly",
-              "monthly",
-              "every_quarter",
-              "every_6_months",
-              "yearly"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/BillingPeriod"
+              }
             ]
           },
           "unit_amount_gross": {
@@ -5252,14 +5358,11 @@
             ]
           },
           "billing_period": {
-            "type": "string",
             "description": "The price billing period.",
-            "enum": [
-              "weekly",
-              "monthly",
-              "every_quarter",
-              "every_6_months",
-              "yearly"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/BillingPeriod"
+              }
             ]
           },
           "pricing_model": {
@@ -5351,14 +5454,11 @@
             "description": "The price type."
           },
           "billing_period": {
-            "type": "string",
             "description": "The price billing period.",
-            "enum": [
-              "weekly",
-              "monthly",
-              "every_quarter",
-              "every_6_months",
-              "yearly"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/BillingPeriod"
+              }
             ]
           },
           "unit_amount_gross": {
@@ -5421,14 +5521,11 @@
             "description": "The price type."
           },
           "billing_period": {
-            "type": "string",
             "description": "The price billing period.",
-            "enum": [
-              "weekly",
-              "monthly",
-              "every_quarter",
-              "every_6_months",
-              "yearly"
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/BillingPeriod"
+              }
             ]
           },
           "amount_total": {
@@ -5901,15 +5998,7 @@
           "_updated_at"
         ],
         "example": {
-          "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-          "_org": "123",
-          "_schema": "contact",
-          "_tags": [
-            "example",
-            "mock"
-          ],
-          "_created_at": "2021-02-09T12:41:43.662Z",
-          "_updated_at": "2021-02-09T12:41:43.662Z"
+          "$ref": "#/components/examples/entity-item/value"
         }
       },
       "EntityRelation": {
@@ -5996,20 +6085,7 @@
           }
         },
         "example": {
-          "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-          "type": "VAT",
-          "description": "Tax description",
-          "active": "true",
-          "region": "DE",
-          "region_label": "Germany",
-          "_org": "123",
-          "_schema": "tax",
-          "_tags": [
-            "example",
-            "mock"
-          ],
-          "_created_at": "2021-02-09T12:41:43.662Z",
-          "_updated_at": "2021-02-09T12:41:43.662Z"
+          "$ref": "#/components/examples/tax/value"
         }
       },
       "TaxBreakdownInfo": {
@@ -6182,30 +6258,7 @@
           }
         },
         "example": {
-          "_id": "123e4567-e89b-12d3-a456-426614174000",
-          "_schema": "coupon",
-          "_org": "org_12345",
-          "_created_at": "2024-01-15T10:00:00.000Z",
-          "_updated_at": "2024-01-20T12:00:00.000Z",
-          "_title": "Sample Coupon",
-          "name": "Sample Coupon",
-          "type": "fixed",
-          "fixed_value": 555,
-          "fixed_value_currency": "USD",
-          "fixed_value_decimal": "5.55",
-          "active": true,
-          "prices": {
-            "$relation": [
-              {
-                "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
-                "_tags": [
-                  "discount",
-                  "special"
-                ],
-                "_schema": "price"
-              }
-            ]
-          }
+          "$ref": "#/components/examples/coupon-without-promo-codes/value"
         }
       },
       "Coupon": {
@@ -6266,10 +6319,7 @@
           }
         },
         "example": {
-          "id": "123e4567-e89b-12d3-a456-426614174000",
-          "code": "123456",
-          "has_usage_limit": true,
-          "usage_limit": 10
+          "$ref": "#/components/examples/promo-code/value"
         }
       },
       "RedeemedPromo": {
@@ -6703,6 +6753,112 @@
           "pricing_details",
           "_meta"
         ]
+      },
+      "ProductRecommendationSearch": {
+        "description": "Product recommendations request payload",
+        "type": "object",
+        "properties": {
+          "product_recommendation_ids": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Product recommendation id"
+            }
+          },
+          "catalog_item": {
+            "type": "object",
+            "description": "The catalog item to be used as source for the recommendation",
+            "properties": {
+              "product_id": {
+                "type": "string",
+                "description": "Product id"
+              },
+              "price_id": {
+                "type": "string",
+                "description": "Product id"
+              }
+            }
+          }
+        }
+      },
+      "ProductRecommendationResponse": {
+        "description": "Product recommendations request payload",
+        "type": "object",
+        "properties": {
+          "hits": {
+            "type": "number",
+            "description": "The number os results returned."
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ProductRecommendation"
+            }
+          }
+        }
+      },
+      "Offer": {
+        "type": "object",
+        "properties": {
+          "product_id": {
+            "type": "string"
+          },
+          "price_id": {
+            "type": "string"
+          },
+          "target_id": {
+            "type": "string"
+          }
+        }
+      },
+      "ProductRecommendation": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/EntityItem"
+          }
+        ],
+        "type": "object",
+        "properties": {
+          "source_price": {
+            "type": "object",
+            "description": "Price being used as source",
+            "properties": {
+              "$relation": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityRelation"
+                }
+              }
+            }
+          },
+          "source_product": {
+            "type": "object",
+            "description": "Product being used as source",
+            "properties": {
+              "$relation": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityRelation"
+                }
+              }
+            }
+          },
+          "type": {
+            "type": "string",
+            "description": "Type of product recommendation",
+            "enum": [
+              "change",
+              "cross-sell",
+              "up-sell"
+            ]
+          },
+          "offer": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Offer"
+            }
+          }
+        }
       }
     },
     "examples": {
@@ -8299,6 +8455,100 @@
             }
           ]
         }
+      },
+      "entity-item": {
+        "value": {
+          "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "_org": "123",
+          "_schema": "contact",
+          "_tags": [
+            "example",
+            "mock"
+          ],
+          "_created_at": "2021-02-09T12:41:43.662Z",
+          "_updated_at": "2021-02-09T12:41:43.662Z"
+        }
+      },
+      "tax": {
+        "value": {
+          "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "type": "VAT",
+          "description": "Tax description",
+          "active": "true",
+          "region": "DE",
+          "region_label": "Germany",
+          "_org": "123",
+          "_schema": "tax",
+          "_tags": [
+            "example",
+            "mock"
+          ],
+          "_created_at": "2021-02-09T12:41:43.662Z",
+          "_updated_at": "2021-02-09T12:41:43.662Z"
+        }
+      },
+      "coupon-without-promo-codes": {
+        "value": {
+          "_id": "123e4567-e89b-12d3-a456-426614174000",
+          "_schema": "coupon",
+          "_org": "org_12345",
+          "_created_at": "2024-01-15T10:00:00.000Z",
+          "_updated_at": "2024-01-20T12:00:00.000Z",
+          "_title": "Sample Coupon",
+          "name": "Sample Coupon",
+          "type": "fixed",
+          "fixed_value": 555,
+          "fixed_value_currency": "USD",
+          "fixed_value_decimal": "5.55",
+          "active": true,
+          "prices": {
+            "$relation": [
+              {
+                "entity_id": "abc12345-def6-7890-gh12-ijklmnopqrst",
+                "_tags": [
+                  "discount",
+                  "special"
+                ],
+                "_schema": "price"
+              }
+            ]
+          }
+        }
+      },
+      "promo-code": {
+        "value": {
+          "id": "123e4567-e89b-12d3-a456-426614174000",
+          "code": "123456",
+          "has_usage_limit": true,
+          "usage_limit": 10
+        }
+      },
+      "price-input-mapping": {
+        "value": {
+          "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+          "frequency_unit": "weekly",
+          "value": 1000.245,
+          "name": "avg consumption",
+          "metadata": {
+            "journey_title": "energy journey",
+            "step_name": "avg consumption picker"
+          }
+        }
+      },
+      "external-fee-mapping": {
+        "value": {
+          "price_id": "589B011B-F8D9-4F8E-AD71-BACE4B543C0F",
+          "frequency_unit": "weekly",
+          "amount_total": 1000,
+          "amount_total_decimal": "10.00"
+        }
+      },
+      "external-fee-mappings": {
+        "value": [
+          {
+            "$ref": "#/components/examples/external-fee-mapping"
+          }
+        ]
       }
     }
   }

package/package.json

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