@epilot/pricing-client 3.43.0 → 3.45.0

package/dist/openapi.d.ts

@@ -270,33 +270,33 @@ declare namespace Components {
              * The date the coupon was last updated
              */
             _updated_at: string; // date-time
-            name: string;
-            description?: string;
+            name: string | null;
+            description?: string | null;
             type?: "fixed" | "percentage";
             category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
-            percentage_value?: string;
+            percentage_value?: string | null;
             /**
              * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
              */
-            fixed_value?: number;
+            fixed_value?: number | null;
             /**
              * 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.
              */
-            fixed_value_decimal?: string;
+            fixed_value_decimal?: string | null;
             /**
              * Use if type is set to fixed. Three-letter ISO currency code, in lowercase.
              */
-            fixed_value_currency?: /* Use if type is set to fixed. Three-letter ISO currency code, in lowercase. */ /**
+            fixed_value_currency?: null & (/* Use if type is set to fixed. 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;
+            Currency);
             /**
              * The cashback period, for now it's limited to either 0 months or 12 months
              */
@@ -1317,6 +1317,7 @@ declare namespace Components {
          */
         export interface CheckoutCart {
             cart?: string | /* A valid cart payload from a client. */ CartDto;
+            redeemed_promos?: RedeemedPromo[];
             mode?: /* The checkout mode for the cart checkout. */ CheckoutMode;
         }
         /**
@@ -2292,33 +2293,33 @@ declare namespace Components {
              * The date the coupon was last updated
              */
             _updated_at: string; // date-time
-            name: string;
-            description?: string;
+            name: string | null;
+            description?: string | null;
             type?: "fixed" | "percentage";
             category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
-            percentage_value?: string;
+            percentage_value?: string | null;
             /**
              * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
              */
-            fixed_value?: number;
+            fixed_value?: number | null;
             /**
              * 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.
              */
-            fixed_value_decimal?: string;
+            fixed_value_decimal?: string | null;
             /**
              * Use if type is set to fixed. Three-letter ISO currency code, in lowercase.
              */
-            fixed_value_currency?: /* Use if type is set to fixed. Three-letter ISO currency code, in lowercase. */ /**
+            fixed_value_currency?: null & (/* Use if type is set to fixed. 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;
+            Currency);
             /**
              * The cashback period, for now it's limited to either 0 months or 12 months
              */
@@ -2412,33 +2413,33 @@ declare namespace Components {
              * The date the coupon was last updated
              */
             _updated_at: string; // date-time
-            name: string;
-            description?: string;
+            name: string | null;
+            description?: string | null;
             type?: "fixed" | "percentage";
             category?: "discount" | "cashback";
             /**
              * Use if type is set to percentage. The percentage to be discounted, represented as a whole integer.
              */
-            percentage_value?: string;
+            percentage_value?: string | null;
             /**
              * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
              */
-            fixed_value?: number;
+            fixed_value?: number | null;
             /**
              * 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.
              */
-            fixed_value_decimal?: string;
+            fixed_value_decimal?: string | null;
             /**
              * Use if type is set to fixed. Three-letter ISO currency code, in lowercase.
              */
-            fixed_value_currency?: /* Use if type is set to fixed. Three-letter ISO currency code, in lowercase. */ /**
+            fixed_value_currency?: null & (/* Use if type is set to fixed. 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;
+            Currency);
             /**
              * The cashback period, for now it's limited to either 0 months or 12 months
              */
@@ -3396,8 +3397,46 @@ declare namespace Components {
             interval?: /* The interval of the tariff if a spot market price is used as base. */ DynamicTariffInterval;
             average_price: number;
             average_price_decimal: string;
-            markup: number;
-            markup_decimal: string;
+            /**
+             * The markup amount, configured in Epilot, in cents.
+             */
+            markup_amount?: number;
+            /**
+             * The markup amount, configured in Epilot, as a string with full precision.
+             */
+            markup_amount_decimal?: string;
+            /**
+             * The markup amount net, configured in Epilot, in cents.
+             */
+            markup_amount_net?: number;
+            /**
+             * The markup amount net, configured in Epilot, as a string with full precision.
+             */
+            markup_amount_net_decimal?: string;
+            /**
+             * The markup amount gross, configured in Epilot, in cents.
+             */
+            markup_amount_gross?: number;
+            /**
+             * The markup amount gross, configured in Epilot, as a string with full precision.
+             */
+            markup_amount_gross_decimal?: string;
+            /**
+             * The unit amount net for the energy price in cents, it's provided by an external provider.
+             */
+            unit_amount_net?: number;
+            /**
+             * The unit amount net for the energy price as a string with full precision, it's provided by an external provider.
+             */
+            unit_amount_net_decimal?: string;
+            /**
+             * The unit amount gross for the energy price in cents, it's provided by an external provider.
+             */
+            unit_amount_gross?: number;
+            /**
+             * The unit amount gross for the energy price as a string with full precision, it's provided by an external provider.
+             */
+            unit_amount_gross_decimal?: string;
         }
         export interface PriceGetAg {
             category: ProductCategory;
@@ -4383,6 +4422,7 @@ declare namespace Components {
              * EUR
              */
             Currency;
+            redeemed_promos?: RedeemedPromo[];
         }
         /**
          * The result from the calculation of a set of price items.
@@ -4432,6 +4472,7 @@ declare namespace Components {
              * EUR
              */
             Currency;
+            redeemed_promos?: RedeemedPromo[];
         }
         /**
          * Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.
@@ -4822,11 +4863,11 @@ declare namespace Components {
             /**
              * The promocode inserted by the customer to redeem the promotion
              */
-            code?: string;
+            code: string;
             /**
              * The coupons that got redeemed with received the code
              */
-            coupons?: /**
+            coupons: /**
              * The coupon configuration
              * example:
              * {
@@ -5240,6 +5281,7 @@ declare namespace Paths {
     namespace $CalculatePricingDetails {
         export interface RequestBody {
             line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ Components.Schemas.PriceItemsDto;
+            redeemed_promos?: Components.Schemas.RedeemedPromo[];
         }
         namespace Responses {
             export type $200 = /* The result from the calculation of a set of price items. */ Components.Schemas.PricingDetailsResponse;

package/dist/openapi.json

@@ -141,6 +141,12 @@
                 "properties": {
                   "line_items": {
                     "$ref": "#/components/schemas/PriceItemsDto"
+                  },
+                  "redeemed_promos": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/RedeemedPromo"
+                    }
                   }
                 }
               },
@@ -3798,6 +3804,12 @@
               }
             ]
           },
+          "redeemed_promos": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RedeemedPromo"
+            }
+          },
           "mode": {
             "$ref": "#/components/schemas/CheckoutMode"
           }
@@ -4581,7 +4593,8 @@
             "enum": [
               "0",
               "12"
-            ]
+            ],
+            "nullable": true
           },
           "after_cashback_amount_total": {
             "type": "integer",
@@ -4774,7 +4787,8 @@
             "enum": [
               "0",
               "12"
-            ]
+            ],
+            "nullable": true
           },
           "amount_total": {
             "type": "integer",
@@ -4941,6 +4955,12 @@
           },
           "currency": {
             "$ref": "#/components/schemas/Currency"
+          },
+          "redeemed_promos": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RedeemedPromo"
+            }
           }
         }
       },
@@ -4959,47 +4979,11 @@
       "PricingDetailsResponse": {
         "type": "object",
         "description": "The result from the calculation of a set of price items.",
-        "properties": {
-          "items": {
-            "type": "array",
-            "items": {
-              "oneOf": [
-                {
-                  "$ref": "#/components/schemas/PriceItem"
-                },
-                {
-                  "$ref": "#/components/schemas/CompositePriceItem"
-                }
-              ]
-            }
-          },
-          "amount_subtotal": {
-            "type": "integer",
-            "description": "Total of all items before (discounts or) taxes are applied."
-          },
-          "amount_total": {
-            "type": "integer",
-            "description": "Total of all items after (discounts and) taxes are applied."
-          },
-          "unit_amount_gross": {
-            "type": "integer",
-            "description": "The unit gross amount value."
-          },
-          "unit_amount_net": {
-            "type": "integer",
-            "description": "The unit net amount value."
-          },
-          "amount_tax": {
-            "type": "integer",
-            "description": "This is the sum of all the price item tax amounts."
-          },
-          "total_details": {
-            "$ref": "#/components/schemas/TotalDetails"
-          },
-          "currency": {
-            "$ref": "#/components/schemas/Currency"
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PricingDetails"
           }
-        }
+        ]
       },
       "BillingPeriod": {
         "type": "string",
@@ -5489,10 +5473,12 @@
             "description": "The date the coupon was last updated"
           },
           "name": {
-            "type": "string"
+            "type": "string",
+            "nullable": true
           },
           "description": {
-            "type": "string"
+            "type": "string",
+            "nullable": true
           },
           "type": {
             "type": "string",
@@ -5510,15 +5496,18 @@
           },
           "percentage_value": {
             "type": "string",
-            "description": "Use if type is set to percentage. The percentage to be discounted, represented as a whole integer."
+            "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"
+            "type": "number",
+            "nullable": true
           },
           "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"
+            "type": "string",
+            "nullable": true
           },
           "fixed_value_currency": {
             "description": "Use if type is set to fixed. Three-letter ISO currency code, in lowercase.",
@@ -5526,7 +5515,8 @@
               {
                 "$ref": "#/components/schemas/Currency"
               }
-            ]
+            ],
+            "nullable": true
           },
           "cashback_period": {
             "type": "string",
@@ -5534,7 +5524,8 @@
             "enum": [
               "0",
               "12"
-            ]
+            ],
+            "nullable": true
           },
           "active": {
             "type": "boolean"
@@ -5657,6 +5648,10 @@
       },
       "RedeemedPromo": {
         "type": "object",
+        "required": [
+          "code",
+          "coupons"
+        ],
         "properties": {
           "code": {
             "description": "The promocode inserted by the customer to redeem the promotion",
@@ -5862,11 +5857,45 @@
           "average_price_decimal": {
             "type": "string"
           },
-          "markup": {
-            "type": "number"
+          "markup_amount": {
+            "type": "number",
+            "description": "The markup amount, configured in Epilot, in cents."
           },
-          "markup_decimal": {
-            "type": "string"
+          "markup_amount_decimal": {
+            "type": "string",
+            "description": "The markup amount, configured in Epilot, as a string with full precision."
+          },
+          "markup_amount_net": {
+            "type": "number",
+            "description": "The markup amount net, configured in Epilot, in cents."
+          },
+          "markup_amount_net_decimal": {
+            "type": "string",
+            "description": "The markup amount net, configured in Epilot, as a string with full precision."
+          },
+          "markup_amount_gross": {
+            "type": "number",
+            "description": "The markup amount gross, configured in Epilot, in cents."
+          },
+          "markup_amount_gross_decimal": {
+            "type": "string",
+            "description": "The markup amount gross, configured in Epilot, as a string with full precision."
+          },
+          "unit_amount_net": {
+            "type": "number",
+            "description": "The unit amount net for the energy price in cents, it's provided by an external provider."
+          },
+          "unit_amount_net_decimal": {
+            "type": "string",
+            "description": "The unit amount net for the energy price as a string with full precision, it's provided by an external provider."
+          },
+          "unit_amount_gross": {
+            "type": "number",
+            "description": "The unit amount gross for the energy price in cents, it's provided by an external provider."
+          },
+          "unit_amount_gross_decimal": {
+            "type": "string",
+            "description": "The unit amount gross for the energy price as a string with full precision, it's provided by an external provider."
           }
         },
         "required": [

package/package.json

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