@epilot/pricing-client 3.7.0 → 3.7.1

package/dist/openapi.d.ts

@@ -252,29 +252,6 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            /**
-             * Price mapping information required to compute totals
-             */
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
-            /**
-             * 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;
         }
         /**
          * Represents a valid base price item from a client.
@@ -285,25 +262,6 @@ declare namespace Components {
              * The quantity of products being purchased.
              */
             quantity?: number;
-            /**
-             * Price mapping information required to compute totals
-             */
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
@@ -777,26 +735,6 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
-            /**
-             * 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;
             /**
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
@@ -808,7 +746,6 @@ declare namespace Components {
              * }
              */
             PriceItem[];
-            total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
         }
         /**
          * Represents a composite price input to the pricing library.
@@ -819,22 +756,6 @@ declare namespace Components {
              * The quantity of products being purchased.
              */
             quantity?: number;
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
@@ -1398,7 +1319,7 @@ declare namespace Components {
              *
              */
             OrderStatus;
-            line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ PriceItemsDto;
+            line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
             /**
              * type of source, e.g. journey or manual
              * example:
@@ -1505,27 +1426,18 @@ declare namespace Components {
              */
             is_composite_price?: boolean;
             /**
-             * Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.
+             * Describes how to compute the price per period. Either `per_unit` or `tiered`.
              * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
-             * - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
-             * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
-             * - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
+             * - `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
              *
-             */
-            pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee";
-            /**
-             * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
+             * ⚠️ Tiered pricing is **not supported** yet.
              *
              */
-            tiers?: PriceTier[];
+            billing_scheme?: "per_unit";
             /**
              * A brief description of the price.
              */
             description?: string;
-            /**
-             * A detailed description of the price. This is shown on the order document and order table.
-             */
-            long_description?: string;
             /**
              * The default tax rate applicable to the product.
              * This field is deprecated, use the new `tax` attribute.
@@ -1549,6 +1461,7 @@ declare namespace Components {
              *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              *   "type": "VAT",
              *   "description": "Tax description",
+             *   "behavior": "Exclusive",
              *   "active": "true",
              *   "region": "DE",
              *   "region_label": "Germany",
@@ -1564,9 +1477,15 @@ declare namespace Components {
              */
             Tax[];
             /**
-             * Specifies whether the price is considered `inclusive` of taxes or not.
+             * Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.
+             * One of `inclusive`, `exclusive`, or `unspecified`.
+             *
+             */
+            tax_behavior?: "inclusive" | "exclusive";
+            /**
+             * Defines the tiered pricing type of the price.
              */
-            is_tax_inclusive?: boolean;
+            tiers_mode?: "standard";
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -1637,7 +1556,7 @@ declare namespace Components {
             /**
              * The unit of measurement used for display purposes and possibly for calculations when the price is variable.
              */
-            unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l" | "cubic-meter" | "cubic-meter-h" | "ls" | "a" | "kva" | "w" | "wp" | "kwp") | string;
+            unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l") | string;
             /**
              * The price creation date
              */
@@ -1679,57 +1598,6 @@ declare namespace Components {
              */
             _tags?: string[];
         }
-        /**
-         * 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"
-         *   }
-         * }
-         */
-        export interface PriceInputMapping {
-            price_id?: string;
-            frequency_unit?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
-            name?: string;
-            value?: number;
-            metadata?: {
-                [name: string]: string;
-            };
-        }
-        /**
-         * 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"
-         *     }
-         *   }
-         * ]
-         */
-        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"
-         *   }
-         * }
-         */
-        PriceInputMapping[];
         /**
          * Represents a price item
          * example:
@@ -1825,39 +1693,14 @@ declare namespace Components {
              * The sum of amounts of the price items by recurrence.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
-            /**
-             * 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;
             /**
              * 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";
             /**
-             * 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
-             * - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
-             * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
-             * - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
-             *
+             * 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'.
              */
-            pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee";
+            on_request_approved?: boolean;
         }
         /**
          * Represents a price input to the pricing library.
@@ -1868,22 +1711,6 @@ declare namespace Components {
              * The quantity of products being purchased.
              */
             quantity?: number;
-            price_mappings?: /**
-             * 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"
-             *     }
-             *   }
-             * ]
-             */
-            PriceInputMappings;
             /**
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
@@ -2003,27 +1830,10 @@ declare namespace Components {
              * The unit amount value
              */
             unit_amount?: number;
-            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;
             /**
              * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
              */
             unit_amount_decimal?: string;
-            /**
-             * 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
-             * - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
-             * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
-             * - `tiered_flatfee` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
-             *
-             */
-            pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee";
             /**
              * The snapshot of the price linked to the price item.
              * example:
@@ -2042,27 +1852,18 @@ declare namespace Components {
                  */
                 is_composite_price?: boolean;
                 /**
-                 * Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.
+                 * Describes how to compute the price per period. Either `per_unit` or `tiered`.
                  * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
-                 * - `tiered_graduated` indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
-                 * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
-                 * - `tiered_flatfee` While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
+                 * - `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
                  *
-                 */
-                pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee";
-                /**
-                 * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
+                 * ⚠️ Tiered pricing is **not supported** yet.
                  *
                  */
-                tiers?: PriceTier[];
+                billing_scheme?: "per_unit";
                 /**
                  * A brief description of the price.
                  */
                 description?: string;
-                /**
-                 * A detailed description of the price. This is shown on the order document and order table.
-                 */
-                long_description?: string;
                 /**
                  * The default tax rate applicable to the product.
                  * This field is deprecated, use the new `tax` attribute.
@@ -2086,6 +1887,7 @@ declare namespace Components {
                  *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  *   "type": "VAT",
                  *   "description": "Tax description",
+                 *   "behavior": "Exclusive",
                  *   "active": "true",
                  *   "region": "DE",
                  *   "region_label": "Germany",
@@ -2101,9 +1903,15 @@ declare namespace Components {
                  */
                 Tax[];
                 /**
-                 * Specifies whether the price is considered `inclusive` of taxes or not.
+                 * Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.
+                 * One of `inclusive`, `exclusive`, or `unspecified`.
+                 *
+                 */
+                tax_behavior?: "inclusive" | "exclusive";
+                /**
+                 * Defines the tiered pricing type of the price.
                  */
-                is_tax_inclusive?: boolean;
+                tiers_mode?: "standard";
                 /**
                  * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
                  */
@@ -2174,7 +1982,7 @@ declare namespace Components {
                 /**
                  * The unit of measurement used for display purposes and possibly for calculations when the price is variable.
                  */
-                unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l" | "cubic-meter" | "cubic-meter-h" | "ls" | "a" | "kva" | "w" | "wp" | "kwp") | string;
+                unit?: /* The unit of measurement used for display purposes and possibly for calculations when the price is variable. */ ("kw" | "kwh" | "m" | "m2" | "l") | string;
                 /**
                  * The price creation date
                  */
@@ -2222,16 +2030,7 @@ declare namespace Components {
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
-        export type PriceItemsDto = (/* Represents a price input to the pricing library. */ PriceItemDto | /* Represents a composite price input to the pricing library. */ CompositePriceItemDto)[];
-        export interface PriceTier {
-            up_to?: number | null;
-            flat_fee_amount?: number;
-            flat_fee_amount_decimal?: string;
-            unit_amount?: number;
-            unit_amount_decimal?: string;
-            display_mode?: PriceTierDisplayMode;
-        }
-        export type PriceTierDisplayMode = "hidden" | "on_request";
+        export type PriceItemsDto = (/* Represents a price input to the pricing library. */ PriceItemDto)[];
         /**
          * The result from the calculation of a set of price items.
          */
@@ -2243,14 +2042,7 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price-item"
              * }
              */
-            PriceItem | /**
-             * Represents a composite price input to the pricing library.
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price-item"
-             * }
-             */
-            CompositePriceItem)[];
+            PriceItem)[];
             /**
              * Total of all items before (discounts or) taxes are applied.
              */
@@ -2406,6 +2198,7 @@ declare namespace Components {
          *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          *   "type": "VAT",
          *   "description": "Tax description",
+         *   "behavior": "Exclusive",
          *   "active": "true",
          *   "region": "DE",
          *   "region_label": "Germany",
@@ -2437,6 +2230,7 @@ declare namespace Components {
             type: "VAT" | "GST" | "Custom";
             description?: string;
             rate: number;
+            behavior: "Exclusive" | "Inclusive" | "exclusive" | "inclusive";
             active?: boolean;
             region?: string;
             region_label?: string;
@@ -2471,6 +2265,7 @@ declare namespace Components {
              *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              *   "type": "VAT",
              *   "description": "Tax description",
+             *   "behavior": "Exclusive",
              *   "active": "true",
              *   "region": "DE",
              *   "region_label": "Germany",
@@ -2521,6 +2316,7 @@ declare namespace Components {
              *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              *   "type": "VAT",
              *   "description": "Tax description",
+             *   "behavior": "Exclusive",
              *   "active": "true",
              *   "region": "DE",
              *   "region_label": "Germany",
@@ -2567,45 +2363,6 @@ declare namespace Components {
                 recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
             };
         }
-        /**
-         * The availability rule error
-         */
-        export interface ValidateAvailabilityFileError {
-            /**
-             * The line number where the error was found
-             */
-            line?: number;
-            /**
-             * The error message
-             */
-            msg: string;
-        }
-        /**
-         * The availability map file result payload
-         * example:
-         * {
-         *   "rules_parsed_count": 8,
-         *   "errors": [
-         *     "File must be UTF-8 encoded",
-         *     "Error on line 3 - street_number must be of type number",
-         *     "Error on line 6 - start_date cant be greater than end_date"
-         *   ]
-         * }
-         */
-        export interface ValidateAvailabilityFileResult {
-            /**
-             * The status of the validation
-             */
-            status: "success" | "error";
-            /**
-             * The number of rules successfully parsed
-             */
-            rules_parsed_count: number;
-            /**
-             * The errors found on the file
-             */
-            errors: /* The availability rule error */ ValidateAvailabilityFileError[];
-        }
     }
 }
 declare namespace Paths {
@@ -2730,34 +2487,6 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
-    namespace $ValidateAvailabilityFile {
-        export interface HeaderParameters {
-            "X-Epilot-Org-ID": Parameters.XEpilotOrgID;
-        }
-        namespace Parameters {
-            export type Id = string;
-            export type XEpilotOrgID = string;
-        }
-        export interface PathParameters {
-            id: Parameters.Id;
-        }
-        namespace Responses {
-            export type $200 = /**
-             * The availability map file result payload
-             * example:
-             * {
-             *   "rules_parsed_count": 8,
-             *   "errors": [
-             *     "File must be UTF-8 encoded",
-             *     "Error on line 3 - street_number must be of type number",
-             *     "Error on line 6 - start_date cant be greater than end_date"
-             *   ]
-             * }
-             */
-            Components.Schemas.ValidateAvailabilityFileResult;
-            export type $400 = Components.Schemas.Error;
-        }
-    }
     namespace CreateOrder {
         export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
         namespace Responses {
@@ -2856,16 +2585,6 @@ export interface OperationMethods {
     data?: Paths.$AvailabilityCheck.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
-  /**
-   * $validateAvailabilityFile - validateAvailabilityFile
-   * 
-   * Validates an availability file, it returns an array of errors if the file is invalid
-   */
-  '$validateAvailabilityFile'(
-    parameters?: Parameters<Paths.$ValidateAvailabilityFile.PathParameters & Paths.$ValidateAvailabilityFile.HeaderParameters> | null,
-    data?: any,
-    config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
   /**
    * $createOpportunity - createOpportunity
    * 
@@ -2954,18 +2673,6 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
   }
-  ['/v1/validate-availability/{id}']: {
-    /**
-     * $validateAvailabilityFile - validateAvailabilityFile
-     * 
-     * Validates an availability file, it returns an array of errors if the file is invalid
-     */
-    'get'(
-      parameters?: Parameters<Paths.$ValidateAvailabilityFile.PathParameters & Paths.$ValidateAvailabilityFile.HeaderParameters> | null,
-      data?: any,
-      config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
-  }
   ['/v1/public/opportunity']: {
     /**
      * $createOpportunity - createOpportunity