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

package/dist/openapi.d.ts

@@ -254,79 +254,71 @@ declare namespace Components {
             _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
-         * The coupon configuration
+         * The common properties for a composite price entity, without the price components
          * 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/composite-price"
          * }
          */
-        export interface BaseCoupon {
+        export interface BaseCompositePrice {
             [name: string]: any;
-            _id: EntityId /* uuid */;
             /**
-             * The auto-generated title for the title
+             * The billing period duration
              */
-            _title: string;
+            billing_duration_amount?: number;
             /**
-             * Organization Id the entity belongs to
+             * The billing period duration unit
              */
-            _org: string;
+            billing_duration_unit?: "weeks" | "months" | "years";
             /**
-             * The schema of the entity, for coupons it is always `coupon`
+             * The notice period duration
              */
-            _schema: "coupon";
-            _tags?: string[];
+            notice_time_amount?: number;
             /**
-             * The creation date for the opportunity
+             * The notice period duration unit
              */
-            _created_at: string; // date-time
+            notice_time_unit?: "weeks" | "months" | "years";
             /**
-             * The date the coupon was last updated
+             * The termination period duration
              */
-            _updated_at: string; // date-time
-            name: string | null;
-            description?: string | null;
-            type: "fixed" | "percentage";
-            category: "discount" | "cashback";
+            termination_time_amount?: number;
             /**
-             * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
+             * The termination period duration unit
              */
-            percentage_value?: string | null;
+            termination_time_unit?: "weeks" | "months" | "years";
             /**
-             * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
+             * The renewal period duration
              */
-            fixed_value?: number;
+            renewal_duration_amount?: number;
             /**
-             * Use if type is set to fixed. The unit amount in cents to be discounted, represented as a decimal string with at most 12 decimal places.
+             * The renewal period duration unit
              */
-            fixed_value_decimal?: string;
+            renewal_duration_unit?: "weeks" | "months" | "years";
             /**
-             * Use if type is set to fixed. Three-letter ISO currency code, in lowercase.
+             * Whether the price can be used for new purchases.
              */
-            fixed_value_currency?: /* Use if type is set to fixed. Three-letter ISO currency code, in lowercase. */ /**
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price[] | {
+                $relation?: PriceComponentRelation[];
+            };
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
              * Three-letter ISO currency code, in lowercase. Must be a supported currency.
              * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
              *
@@ -335,30 +327,36 @@ declare namespace Components {
              */
             Currency;
             /**
-             * The cashback period, for now it's limited to either 0 months or 12 months
+             * The flag for prices that contain price components.
              */
-            cashback_period?: "0" | "12";
-            active?: boolean;
+            is_composite_price: true;
             /**
-             * Whether the coupon requires a promo code to be applied
+             * The price creation date
              */
-            requires_promo_code?: boolean;
+            _created_at?: string;
             /**
-             * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
+             * The price id
              */
-            prices?: /* The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise. */ {
-                $relation?: EntityRelation[];
-            } | /**
-             * The price entity schema for simple pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price"
-             * }
+            _id?: string;
+            /**
+             * The price autogenerated title
              */
-            Price[];
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
         }
         /**
-         * The coupon configuration
+         * The shared properties for the coupon entity and coupon item entity
          */
         export interface BaseCouponCommon {
             [name: string]: any;
@@ -766,14 +764,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -785,7 +776,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
@@ -1095,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;
@@ -1123,7 +1109,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
         }
         export interface BasicAuthCredentials {
             /**
@@ -1381,33 +1367,10 @@ declare namespace Components {
              * }
              */
             Price | /**
-             * The coupon configuration
+             * 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)[];
@@ -1438,107 +1401,23 @@ declare namespace Components {
          */
         export type CheckoutMode = "create_order" | "create_invoice" | "create_quote";
         /**
-         * The price entity schema for dynamic pricing
+         * The composite price entity
+         */
+        export type CompositePrice = /* The composite price entity */ /**
+         * The composite price entity
          * example:
          * {
          *   "$ref": "#/components/examples/composite-price"
          * }
          */
-        export interface CompositePrice {
-            [name: string]: any;
-            /**
-             * The billing period duration
-             */
-            billing_duration_amount?: number;
-            /**
-             * The billing period duration unit
-             */
-            billing_duration_unit?: "weeks" | "months" | "years";
-            /**
-             * The notice period duration
-             */
-            notice_time_amount?: number;
-            /**
-             * The notice period duration unit
-             */
-            notice_time_unit?: "weeks" | "months" | "years";
-            /**
-             * The termination period duration
-             */
-            termination_time_amount?: number;
-            /**
-             * The termination period duration unit
-             */
-            termination_time_unit?: "weeks" | "months" | "years";
-            /**
-             * The renewal period duration
-             */
-            renewal_duration_amount?: number;
-            /**
-             * The renewal period duration unit
-             */
-            renewal_duration_unit?: "weeks" | "months" | "years";
-            /**
-             * Whether the price can be used for new purchases.
-             */
-            active?: boolean;
-            /**
-             * A brief description of the price.
-             */
-            description?: string;
-            /**
-             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
-             */
-            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
-             * The price entity schema for simple pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price"
-             * }
-             */
-            Price[] | {
-                $relation?: PriceComponentRelation[];
-            };
-            /**
-             * Three-letter ISO currency code, in lowercase.
-             */
-            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
-             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
-             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
-             *
-             * example:
-             * EUR
-             */
-            Currency;
-            /**
-             * The flag for prices that contain price components.
-             */
-            is_composite_price: true;
-            /**
-             * The price creation date
-             */
-            _created_at?: string;
-            /**
-             * The price id
-             */
-            _id?: string;
-            /**
-             * The price autogenerated title
-             */
-            _title?: string;
-            /**
-             * The price last update date
-             */
-            _updated_at?: string;
-            /**
-             * The organization id the price belongs to
-             */
-            _org_id?: string;
-            /**
-             * An arbitrary set of tags attached to the composite price
-             */
-            _tags?: string[];
-        }
+        NonHydratedCompositePrice | /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        HydratedCompositePrice;
         /**
          * Represents a composite price input to the pricing library.
          * example:
@@ -1862,14 +1741,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -1881,7 +1753,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
@@ -2054,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;
@@ -2082,7 +1949,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * The flag for prices that contain price components.
              */
@@ -2101,14 +1968,7 @@ declare namespace Components {
             price_component_coupon_ids?: {
                 [name: string]: string[];
             };
-            _price?: /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            _price?: /* The composite price entity */ CompositePrice;
         }
         /**
          * The compute price payload
@@ -2337,33 +2197,10 @@ declare namespace Components {
         }
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
         /**
-         * The coupon configuration
+         * 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 {
@@ -2442,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[];
@@ -2457,7 +2291,7 @@ declare namespace Components {
             };
         }
         /**
-         * The coupon configuration
+         * The shared properties for the coupon entity and coupon item entity
          */
         export interface CouponItem {
             [name: string]: any;
@@ -2521,33 +2355,10 @@ declare namespace Components {
             requires_promo_code?: boolean;
         }
         /**
-         * The coupon configuration
+         * 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 {
@@ -2655,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 {
@@ -2710,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 {
@@ -2724,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[];
@@ -2850,18 +2642,106 @@ declare namespace Components {
          */
         export interface HistoricMarketPriceRecord {
             /**
-             * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
-             * example:
-             * 12.3
+             * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
+             * example:
+             * 12.3
+             */
+            unit_amount: number;
+            /**
+             * Cost in decimal format, e.g. 0.123€.
+             * example:
+             * 0.123
+             */
+            unit_amount_decimal: string;
+            unit_amount_currency: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * ISO 8601 timestamp of the price record in UTC.
+             */
+            timestamp: string; // date-time
+        }
+        export interface HistoricMarketPricesResult {
+            market: /* The market for a spot market price. */ SpotMarketType;
+            bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
+            prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
+        }
+        /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        export interface HydratedCompositePrice {
+            [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
              */
-            unit_amount: number;
+            renewal_duration_unit?: "weeks" | "months" | "years";
             /**
-             * Cost in decimal format, e.g. 0.123€.
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ /**
+             * The price entity schema for simple pricing
              * example:
-             * 0.123
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
              */
-            unit_amount_decimal: string;
-            unit_amount_currency: /**
+            Price[] | /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price[];
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
              * Three-letter ISO currency code, in lowercase. Must be a supported currency.
              * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
              *
@@ -2870,14 +2750,33 @@ declare namespace Components {
              */
             Currency;
             /**
-             * ISO 8601 timestamp of the price record in UTC.
+             * The flag for prices that contain price components.
              */
-            timestamp: string; // date-time
-        }
-        export interface HistoricMarketPricesResult {
-            market: /* The market for a spot market price. */ SpotMarketType;
-            bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
-            prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
+            is_composite_price: true;
+            /**
+             * The price creation date
+             */
+            _created_at?: string;
+            /**
+             * The price id
+             */
+            _id?: string;
+            /**
+             * The price autogenerated title
+             */
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
         }
         /**
          * The auth credentials for external integrations
@@ -2971,6 +2870,103 @@ declare namespace Components {
              */
             value?: string;
         })[];
+        /**
+         * The composite price entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        export interface NonHydratedCompositePrice {
+            [name: string]: any;
+            /**
+             * The billing period duration
+             */
+            billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
+            billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
+            notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
+            notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
+            termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
+            termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
+            renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
+            renewal_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: /* A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price. */ {
+                $relation?: PriceComponentRelation[];
+            } | {
+                $relation?: PriceComponentRelation[];
+            };
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price: true;
+            /**
+             * The price creation date
+             */
+            _created_at?: string;
+            /**
+             * The price id
+             */
+            _id?: string;
+            /**
+             * The price autogenerated title
+             */
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
+        }
         export interface OAuthCredentials {
             /**
              * The OAuth client ID
@@ -3029,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:
@@ -3555,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[];
@@ -3770,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 {
@@ -3807,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[];
@@ -4141,14 +4115,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /**
-             * The price entity schema for dynamic pricing
-             * example:
-             * {
-             *   "$ref": "#/components/examples/composite-price"
-             * }
-             */
-            CompositePrice;
+            Price | /* The composite price entity */ CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -4160,7 +4127,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * When set to true on a `_price` displayed as OnRequest (`show_as_on_request: 'on_request'`) this flag means the price has been approved and can now be displayed to the customer. This flag is only valid for prices shown as 'on_request'.
              */
@@ -4176,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
@@ -4343,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;
@@ -4371,7 +4333,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The coupon configuration */ CouponItem)[];
+            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -4379,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
              */
@@ -4508,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[];
@@ -4855,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 {
@@ -4884,36 +4903,13 @@ declare namespace Components {
          */
         export interface PromoCodeValidationResponse {
             matched_coupons?: /**
-             * The coupon configuration
+             * 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"
              * }
              */
-            BaseCoupon[];
+            CouponWithoutPromoCodes[];
         }
         /**
          * The provider entity
@@ -4995,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.
              */
@@ -5088,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.
              */
@@ -5113,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.
              */
@@ -5142,33 +5138,10 @@ declare namespace Components {
              * The coupons that got redeemed with received the code
              */
             coupons: /**
-             * The coupon configuration
+             * 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[];
@@ -5270,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 {
@@ -5335,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;
@@ -5385,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;
@@ -5668,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;
@@ -6052,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 {
@@ -6282,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>
@@ -6295,7 +6264,7 @@ export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
 export type AvailabilityResult = Components.Schemas.AvailabilityResult;
 export type AverageMarketPriceRecord = Components.Schemas.AverageMarketPriceRecord;
 export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
-export type BaseCoupon = Components.Schemas.BaseCoupon;
+export type BaseCompositePrice = Components.Schemas.BaseCompositePrice;
 export type BaseCouponCommon = Components.Schemas.BaseCouponCommon;
 export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
@@ -6344,14 +6313,17 @@ export type File = Components.Schemas.File;
 export type GasConcessionType = Components.Schemas.GasConcessionType;
 export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
 export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
+export type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice;
 export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCredentials;
 export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
 export type IntegrationId = Components.Schemas.IntegrationId;
 export type JourneyContext = Components.Schemas.JourneyContext;
 export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
 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;
@@ -6381,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;