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

package/dist/openapi.d.ts

@@ -254,111 +254,36 @@ declare namespace Components {
             _meta?: /* Signature meta data payload */ SignatureMeta;
         }
         /**
-         * The common properties for a composite price entity, without the price components
+         * The coupon configuration
          * example:
          * {
-         *   "$ref": "#/components/examples/composite-price"
+         *   "_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"
+         *       }
+         *     ]
+         *   }
          * }
          */
-        export interface BaseCompositePrice {
-            [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[];
-        }
-        /**
-         * The shared properties for the coupon entity and coupon item entity
-         */
-        export interface BaseCouponCommon {
+        export interface BaseCoupon {
             [name: string]: any;
             _id: EntityId /* uuid */;
             /**
@@ -384,8 +309,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type: "fixed" | "percentage";
-            category: "discount" | "cashback";
+            type?: "fixed" | "percentage";
+            category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -418,6 +343,19 @@ declare namespace Components {
              * Whether the coupon requires a promo code to be applied
              */
             requires_promo_code?: boolean;
+            /**
+             * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
+             */
+            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"
+             * }
+             */
+            Price[];
         }
         export interface BaseMarketPriceRecord {
             /**
@@ -764,7 +702,14 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /* The composite price entity */ CompositePrice;
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -776,7 +721,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (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'.
              */
@@ -1114,7 +1059,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (CouponItem)[];
         }
         export interface BasicAuthCredentials {
             /**
@@ -1372,7 +1317,7 @@ declare namespace Components {
              * }
              */
             Price | /**
-             * The coupon entity
+             * The coupon configuration
              * example:
              * {
              *   "_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -1429,23 +1374,107 @@ declare namespace Components {
          */
         export type CheckoutMode = "create_order" | "create_invoice" | "create_quote";
         /**
-         * The composite price entity
-         */
-        export type CompositePrice = /* The composite price entity */ /**
-         * The composite price entity
+         * The price entity schema for dynamic pricing
          * example:
          * {
          *   "$ref": "#/components/examples/composite-price"
          * }
          */
-        NonHydratedCompositePrice | /**
-         * The composite price entity
-         * example:
-         * {
-         *   "$ref": "#/components/examples/composite-price"
-         * }
-         */
-        HydratedCompositePrice;
+        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?: boolean;
+            /**
+             * 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[];
+        }
         /**
          * Represents a composite price input to the pricing library.
          * example:
@@ -1769,7 +1798,14 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /* The composite price entity */ CompositePrice;
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -1781,15 +1817,11 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (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'.
              */
             on_request_approved?: boolean;
-            /**
-             * The flag for prices that contain price components.
-             */
-            is_composite_price: true;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -1982,11 +2014,11 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (CouponItem)[];
             /**
              * The flag for prices that contain price components.
              */
-            is_composite_price: true;
+            is_composite_price?: true;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -2001,7 +2033,14 @@ declare namespace Components {
             price_component_coupon_ids?: {
                 [name: string]: string[];
             };
-            _price?: /* The composite price entity */ CompositePrice;
+            _price?: /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
         }
         /**
          * The compute price payload
@@ -2230,7 +2269,7 @@ declare namespace Components {
         }
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
         /**
-         * The coupon entity
+         * The coupon configuration
          * example:
          * {
          *   "_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -2285,8 +2324,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type: "fixed" | "percentage";
-            category: "discount" | "cashback";
+            type?: "fixed" | "percentage";
+            category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -2349,20 +2388,16 @@ declare namespace Components {
                 [name: string]: number;
             };
         }
-        /**
-         * The shared properties for the coupon entity and coupon item entity
-         */
         export interface CouponItem {
-            [name: string]: any;
-            _id: EntityId /* uuid */;
+            _id?: EntityId /* uuid */;
             /**
              * The auto-generated title for the title
              */
-            _title: string;
+            _title?: string;
             /**
              * Organization Id the entity belongs to
              */
-            _org: string;
+            _org?: string;
             /**
              * The schema of the entity, for coupons it is always `coupon`
              */
@@ -2371,12 +2406,12 @@ declare namespace Components {
             /**
              * The creation date for the opportunity
              */
-            _created_at: string; // date-time
+            _created_at?: string; // date-time
             /**
              * The date the coupon was last updated
              */
-            _updated_at: string; // date-time
-            name: string | null;
+            _updated_at?: string; // date-time
+            name?: string | null;
             description?: string | null;
             type: "fixed" | "percentage";
             category: "discount" | "cashback";
@@ -2414,7 +2449,7 @@ declare namespace Components {
             requires_promo_code?: boolean;
         }
         /**
-         * The base for the coupon entity without promo codes
+         * The coupon configuration
          * example:
          * {
          *   "_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -2469,8 +2504,8 @@ declare namespace Components {
             _updated_at: string; // date-time
             name: string | null;
             description?: string | null;
-            type: "fixed" | "percentage";
-            category: "discount" | "cashback";
+            type?: "fixed" | "percentage";
+            category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
@@ -2772,113 +2807,6 @@ declare namespace Components {
             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
-             */
-            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[] | /**
-             * 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
-             *
-             * 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[];
-        }
         /**
          * The auth credentials for external integrations
          */
@@ -2971,103 +2899,6 @@ 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
@@ -3607,7 +3438,7 @@ declare namespace Components {
             /**
              * The flag for prices that contain price components.
              */
-            is_composite_price?: false;
+            is_composite_price?: boolean;
             /**
              * 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
@@ -4238,7 +4069,14 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price | /* The composite price entity */ CompositePrice;
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
             /**
              * The taxes applied to the price item.
              */
@@ -4250,7 +4088,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (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'.
              */
@@ -4259,10 +4097,6 @@ declare namespace Components {
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
             type?: "one_time" | "recurring";
-            /**
-             * The flag for prices that contain price components.
-             */
-            is_composite_price?: false;
             /**
              * The price billing period.
              */
@@ -4461,7 +4295,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (/* The shared properties for the coupon entity and coupon item entity */ CouponItem)[];
+            _coupons?: (CouponItem)[];
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -4553,7 +4387,7 @@ declare namespace Components {
                 /**
                  * The flag for prices that contain price components.
                  */
-                is_composite_price?: false;
+                is_composite_price?: boolean;
                 /**
                  * 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
@@ -4686,7 +4520,7 @@ declare namespace Components {
                 _tags?: string[];
             };
         }
-        export type PriceItemDtoUnion = /* Represents a price input to the pricing library. */ PriceItemDto | /* Represents a composite price input to the pricing library. */ CompositePriceItemDto;
+        export type PriceItemUnion = /* Represents a price input to the pricing library. */ PriceItemDto | /* Represents a composite price input to the pricing library. */ CompositePriceItemDto;
         /**
          * Tracks a set of product prices, quantities, (discounts) and taxes.
          */
@@ -4708,7 +4542,7 @@ declare namespace Components {
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
-        export type PriceItemsDto = PriceItemDtoUnion[];
+        export type PriceItemsDto = PriceItemUnion[];
         export interface PriceTier {
             up_to?: number | null;
             flat_fee_amount?: number;
@@ -4974,7 +4808,7 @@ declare namespace Components {
          */
         export interface PromoCodeValidationResponse {
             matched_coupons?: /**
-             * The base for the coupon entity without promo codes
+             * The coupon configuration
              * example:
              * {
              *   "_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -5003,7 +4837,7 @@ declare namespace Components {
              *   }
              * }
              */
-            CouponWithoutPromoCodes[];
+            BaseCoupon[];
         }
         /**
          * The provider entity
@@ -5232,7 +5066,7 @@ declare namespace Components {
              * The coupons that got redeemed with received the code
              */
             coupons: /**
-             * The base for the coupon entity without promo codes
+             * The coupon configuration
              * example:
              * {
              *   "_id": "123e4567-e89b-12d3-a456-426614174000",
@@ -6385,8 +6219,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 BaseCompositePrice = Components.Schemas.BaseCompositePrice;
-export type BaseCouponCommon = Components.Schemas.BaseCouponCommon;
+export type BaseCoupon = Components.Schemas.BaseCoupon;
 export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
@@ -6434,14 +6267,12 @@ 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 Opportunity = Components.Schemas.Opportunity;
@@ -6462,7 +6293,7 @@ export type PriceInputMapping = Components.Schemas.PriceInputMapping;
 export type PriceInputMappings = Components.Schemas.PriceInputMappings;
 export type PriceItem = Components.Schemas.PriceItem;
 export type PriceItemDto = Components.Schemas.PriceItemDto;
-export type PriceItemDtoUnion = Components.Schemas.PriceItemDtoUnion;
+export type PriceItemUnion = Components.Schemas.PriceItemUnion;
 export type PriceItems = Components.Schemas.PriceItems;
 export type PriceItemsDto = Components.Schemas.PriceItemsDto;
 export type PriceTier = Components.Schemas.PriceTier;

package/dist/openapi.json

@@ -2841,10 +2841,7 @@
           },
           "is_composite_price": {
             "description": "The flag for prices that contain price components.",
-            "type": "boolean",
-            "enum": [
-              false
-            ]
+            "type": "boolean"
           },
           "pricing_model": {
             "type": "string",
@@ -3020,22 +3017,19 @@
           "pricing_model"
         ]
       },
-      "BaseCompositePrice": {
+      "CompositePrice": {
         "allOf": [
           {
             "$ref": "#/components/schemas/PriceConditions"
           }
         ],
         "type": "object",
-        "description": "The common properties for a composite price entity, without the price components",
+        "description": "The price entity schema for dynamic pricing",
         "example": {
           "$ref": "#/components/examples/composite-price"
         },
         "additionalProperties": true,
         "readOnly": true,
-        "required": [
-          "is_composite_price"
-        ],
         "properties": {
           "active": {
             "type": "boolean",
@@ -3077,10 +3071,7 @@
           },
           "is_composite_price": {
             "description": "The flag for prices that contain price components.",
-            "type": "boolean",
-            "enum": [
-              true
-            ]
+            "type": "boolean"
           },
           "_created_at": {
             "description": "The price creation date",
@@ -3111,58 +3102,6 @@
           }
         }
       },
-      "NonHydratedCompositePrice": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseCompositePrice"
-          }
-        ],
-        "type": "object",
-        "description": "The composite price entity",
-        "properties": {
-          "price_components": {
-            "description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.",
-            "type": "object",
-            "properties": {
-              "$relation": {
-                "type": "array",
-                "items": {
-                  "$ref": "#/components/schemas/PriceComponentRelation"
-                }
-              }
-            }
-          }
-        }
-      },
-      "HydratedCompositePrice": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseCompositePrice"
-          }
-        ],
-        "type": "object",
-        "description": "The composite price entity",
-        "properties": {
-          "price_components": {
-            "description": "A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.",
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/Price"
-            }
-          }
-        }
-      },
-      "CompositePrice": {
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/NonHydratedCompositePrice"
-          },
-          {
-            "$ref": "#/components/schemas/HydratedCompositePrice"
-          }
-        ],
-        "description": "The composite price entity"
-      },
       "PriceComponentRelation": {
         "type": "object",
         "properties": {
@@ -4448,7 +4387,7 @@
           }
         }
       },
-      "PriceItemDtoUnion": {
+      "PriceItemUnion": {
         "anyOf": [
           {
             "$ref": "#/components/schemas/PriceItemDto"
@@ -4469,7 +4408,7 @@
         "description": "A valid set of product prices, quantities, (discounts) and taxes from a client.",
         "type": "array",
         "items": {
-          "$ref": "#/components/schemas/PriceItemDtoUnion"
+          "$ref": "#/components/schemas/PriceItemUnion"
         }
       },
       "BasePriceItemDto": {
@@ -4626,9 +4565,6 @@
           },
           {
             "type": "object",
-            "required": [
-              "is_composite_price"
-            ],
             "properties": {
               "is_composite_price": {
                 "description": "The flag for prices that contain price components.",
@@ -4936,17 +4872,7 @@
         ],
         "description": "Represents a composite price input to the pricing library.",
         "type": "object",
-        "required": [
-          "is_composite_price"
-        ],
         "properties": {
-          "is_composite_price": {
-            "description": "The flag for prices that contain price components.",
-            "type": "boolean",
-            "enum": [
-              true
-            ]
-          },
           "item_components": {
             "type": "array",
             "description": "Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).",
@@ -5244,13 +5170,6 @@
               "recurring"
             ]
           },
-          "is_composite_price": {
-            "description": "The flag for prices that contain price components.",
-            "type": "boolean",
-            "enum": [
-              false
-            ]
-          },
           "billing_period": {
             "type": "string",
             "description": "The price billing period.",
@@ -5583,7 +5502,7 @@
           "matched_coupons": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/CouponWithoutPromoCodes"
+              "$ref": "#/components/schemas/BaseCoupon"
             }
           }
         }
@@ -6032,9 +5951,9 @@
           }
         }
       },
-      "BaseCouponCommon": {
+      "BaseCoupon": {
         "type": "object",
-        "description": "The shared properties for the coupon entity and coupon item entity",
+        "description": "The coupon configuration",
         "additionalProperties": true,
         "required": [
           "name",
@@ -6043,9 +5962,7 @@
           "_org",
           "_schema",
           "_created_at",
-          "_updated_at",
-          "type",
-          "category"
+          "_updated_at"
         ],
         "properties": {
           "_id": {
@@ -6146,18 +6063,7 @@
           "requires_promo_code": {
             "type": "boolean",
             "description": "Whether the coupon requires a promo code to be applied"
-          }
-        }
-      },
-      "CouponWithoutPromoCodes": {
-        "type": "object",
-        "description": "The base for the coupon entity without promo codes",
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/BaseCouponCommon"
-          }
-        ],
-        "properties": {
+          },
           "prices": {
             "description": "The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.",
             "oneOf": [
@@ -6209,10 +6115,9 @@
         }
       },
       "Coupon": {
-        "description": "The coupon entity",
         "allOf": [
           {
-            "$ref": "#/components/schemas/CouponWithoutPromoCodes"
+            "$ref": "#/components/schemas/BaseCoupon"
           }
         ],
         "type": "object",
@@ -6234,9 +6139,117 @@
       },
       "CouponItem": {
         "type": "object",
+        "required": [
+          "type",
+          "category",
+          "_schema"
+        ],
+        "properties": {
+          "_id": {
+            "$ref": "#/components/schemas/EntityId",
+            "readOnly": true
+          },
+          "_title": {
+            "type": "string",
+            "description": "The auto-generated title for the title",
+            "readOnly": true
+          },
+          "_org": {
+            "type": "string",
+            "description": "Organization Id the entity belongs to",
+            "readOnly": true
+          },
+          "_schema": {
+            "type": "string",
+            "enum": [
+              "coupon"
+            ],
+            "readOnly": true,
+            "description": "The schema of the entity, for coupons it is always `coupon`"
+          },
+          "_tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "_created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "The creation date for the opportunity"
+          },
+          "_updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true,
+            "description": "The date the coupon was last updated"
+          },
+          "name": {
+            "type": "string",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "nullable": true
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "fixed",
+              "percentage"
+            ]
+          },
+          "category": {
+            "type": "string",
+            "enum": [
+              "discount",
+              "cashback"
+            ]
+          },
+          "percentage_value": {
+            "type": "string",
+            "description": "Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.",
+            "nullable": true
+          },
+          "fixed_value": {
+            "description": "Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.",
+            "type": "number"
+          },
+          "fixed_value_decimal": {
+            "description": "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.",
+            "type": "string"
+          },
+          "fixed_value_currency": {
+            "description": "Use if type is set to fixed. Three-letter ISO currency code, in lowercase.",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/Currency"
+              }
+            ]
+          },
+          "cashback_period": {
+            "type": "string",
+            "description": "The cashback period, for now it's limited to either 0 months or 12 months",
+            "enum": [
+              "0",
+              "12"
+            ],
+            "nullable": true
+          },
+          "active": {
+            "type": "boolean"
+          },
+          "requires_promo_code": {
+            "type": "boolean",
+            "description": "Whether the coupon requires a promo code to be applied"
+          }
+        }
+      },
+      "CouponWithoutPromoCodes": {
         "allOf": [
           {
-            "$ref": "#/components/schemas/BaseCouponCommon"
+            "$ref": "#/components/schemas/BaseCoupon"
           }
         ]
       },

package/package.json

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