@epilot/pricing-client 3.35.13 → 3.35.14-beta.1

package/dist/openapi.d.ts

@@ -97,6 +97,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -244,6 +256,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -907,6 +931,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -996,6 +1032,19 @@ declare namespace Components {
                 [name: string]: any;
             };
         }
+        /**
+         * An amount associated with a specific cashback period.
+         */
+        export interface CashbackAmount {
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * The sum of all cashbacks for a specific cashback period
+             */
+            amount_total?: number;
+        }
         /**
          * A catalog search payload
          * example:
@@ -1231,6 +1280,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -2075,13 +2136,6 @@ declare namespace Components {
              */
             cause?: string;
         }
-        /**
-         * An external product & price information (already computed) from an external catalog.
-         */
-        export interface ExternalCatalogItem {
-            pricing_details: /* The result from the calculation of a set of price items. */ PricingDetails;
-            _meta: /* Signature meta data payload */ SignatureMeta;
-        }
         export interface ExternalCompositePrice {
             /**
              * Fees structure with static and variable amounts
@@ -2330,6 +2384,74 @@ declare namespace Components {
                 }[];
             };
         }
+        /**
+         * An external product & price information (already computed) from an external catalog.
+         */
+        export interface ExternalProduct {
+            /**
+             * The ID of the product in the external catalog.
+             */
+            id: string;
+            /**
+             * The name of the product.
+             */
+            name: string;
+            /**
+             * A description of the product.
+             */
+            description?: string;
+            /**
+             * A list of features of the product.
+             */
+            features?: string[];
+            /**
+             * A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
+             *
+             */
+            product_image_urls?: string[];
+            /**
+             * A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.
+             *
+             */
+            product_downloads_urls?: string[];
+            /**
+             * Legal footnotes for the product.
+             */
+            legal_footnotes?: string;
+            /**
+             * Additional notes for the product.
+             */
+            additional_notes?: string[];
+            /**
+             * Recommendation settings for the product.
+             * example:
+             * {
+             *   "is_recommended": true,
+             *   "recommended_label": "Best Value",
+             *   "recommended_color": "#00FF00",
+             *   "recommended_label_color": "#FFFFFF"
+             * }
+             */
+            recommendation_settings?: {
+                /**
+                 * Flag to enable or disable the recommendation for this product.
+                 */
+                is_recommended?: boolean;
+                /**
+                 * Label to display when the product is recommended.
+                 */
+                recommended_label?: string;
+                /**
+                 * Color to display when the product is recommended.
+                 */
+                recommended_color?: string;
+                /**
+                 * Color of the recommended label.
+                 */
+                recommended_label_color?: string;
+            };
+            price: ExternalSimplePrice | ExternalCompositePrice;
+        }
         export interface ExternalSimplePrice {
             /**
              * Fees structure with static and variable amounts
@@ -3355,6 +3477,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -4346,6 +4480,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -4423,6 +4569,18 @@ declare namespace Components {
              * The cashback amount as a string with all the decimal places.
              */
             cashback_amount_decimal?: string;
+            /**
+             * The cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            /**
+             * Total amount after cashback is applied.
+             */
+            after_cashback_amount_total?: number;
+            /**
+             * Total amount after cashback is applied as a string with all the decimal places.
+             */
+            after_cashback_amount_total_decimal?: string;
             /**
              * The discount percentage, if the applied coupon had a percentage type.
              */
@@ -4497,7 +4655,7 @@ declare namespace Components {
              * The number os results returned.
              */
             hits: number;
-            results: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
+            results: /* An external product & price information (already computed) from an external catalog. */ ExternalProduct[];
         }
         /**
          * A search providers payload
@@ -4744,6 +4902,10 @@ declare namespace Components {
                  * The aggregated price items tax amount per rate.
                  */
                 recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
+                /**
+                 * The list of cashback sums for each cashback period.
+                 */
+                cashbacks?: (/* An amount associated with a specific cashback period. */ CashbackAmount)[];
                 /**
                  * The aggregated price items recurrences by tax rate
                  */
@@ -5471,6 +5633,7 @@ export type BasicAuthCredentials = Components.Schemas.BasicAuthCredentials;
 export type BillingPeriod = Components.Schemas.BillingPeriod;
 export type Cart = Components.Schemas.Cart;
 export type CartDto = Components.Schemas.CartDto;
+export type CashbackAmount = Components.Schemas.CashbackAmount;
 export type CatalogSearch = Components.Schemas.CatalogSearch;
 export type CatalogSearchResult = Components.Schemas.CatalogSearchResult;
 export type CheckoutCart = Components.Schemas.CheckoutCart;
@@ -5495,13 +5658,13 @@ export type EntityId = Components.Schemas.EntityId;
 export type EntityItem = Components.Schemas.EntityItem;
 export type EntityRelation = Components.Schemas.EntityRelation;
 export type Error = Components.Schemas.Error;
-export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
 export type ExternalCompositePrice = Components.Schemas.ExternalCompositePrice;
 export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
 export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
 export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata;
 export type ExternalPriceFees = Components.Schemas.ExternalPriceFees;
 export type ExternalPriceTotalDetails = Components.Schemas.ExternalPriceTotalDetails;
+export type ExternalProduct = Components.Schemas.ExternalProduct;
 export type ExternalSimplePrice = Components.Schemas.ExternalSimplePrice;
 export type File = Components.Schemas.File;
 export type GasConcessionType = Components.Schemas.GasConcessionType;

package/dist/openapi.json

@@ -4099,6 +4099,24 @@
             "description": "The cashback amount as a string with all the decimal places.",
             "readOnly": true
           },
+          "cashback_period": {
+            "type": "string",
+            "description": "The cashback period, for now it's limited to either 0 months or 12 months",
+            "enum": [
+              "0",
+              "12"
+            ]
+          },
+          "after_cashback_amount_total": {
+            "type": "integer",
+            "description": "Total amount after cashback is applied.",
+            "readOnly": true
+          },
+          "after_cashback_amount_total_decimal": {
+            "type": "string",
+            "description": "Total amount after cashback is applied as a string with all the decimal places.",
+            "readOnly": true
+          },
           "discount_percentage": {
             "type": "integer",
             "description": "The discount percentage, if the applied coupon had a percentage type.",
@@ -4267,6 +4285,24 @@
           "amount_total_decimal"
         ]
       },
+      "CashbackAmount": {
+        "type": "object",
+        "description": "An amount associated with a specific cashback period.",
+        "properties": {
+          "cashback_period": {
+            "type": "string",
+            "description": "The cashback period, for now it's limited to either 0 months or 12 months",
+            "enum": [
+              "0",
+              "12"
+            ]
+          },
+          "amount_total": {
+            "type": "integer",
+            "description": "The sum of all cashbacks for a specific cashback period"
+          }
+        }
+      },
       "RecurrenceAmountWithTax": {
         "type": "object",
         "description": "An amount associated with a specific recurrence.",
@@ -4354,6 +4390,17 @@
                   ]
                 }
               },
+              "cashbacks": {
+                "type": "array",
+                "description": "The list of cashback sums for each cashback period.",
+                "items": {
+                  "oneOf": [
+                    {
+                      "$ref": "#/components/schemas/CashbackAmount"
+                    }
+                  ]
+                }
+              },
               "recurrencesByTax": {
                 "type": "array",
                 "description": "The aggregated price items recurrences by tax rate",
@@ -5349,7 +5396,7 @@
           "results": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ExternalCatalogItem"
+              "$ref": "#/components/schemas/ExternalProduct"
             }
           }
         },
@@ -5358,20 +5405,97 @@
           "hits"
         ]
       },
-      "ExternalCatalogItem": {
+      "ExternalProduct": {
         "type": "object",
         "description": "An external product & price information (already computed) from an external catalog.",
         "properties": {
-          "pricing_details": {
-            "$ref": "#/components/schemas/PricingDetails"
+          "id": {
+            "type": "string",
+            "description": "The ID of the product in the external catalog."
           },
-          "_meta": {
-            "$ref": "#/components/schemas/SignatureMeta"
+          "name": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "description": {
+            "type": "string",
+            "description": "A description of the product."
+          },
+          "features": {
+            "type": "array",
+            "description": "A list of features of the product.",
+            "items": {
+              "type": "string"
+            }
+          },
+          "product_image_urls": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "A list of image URLs of the product. RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
+          },
+          "product_downloads_urls": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "A list of file/attachment URLs of the product RECOMMENDED: Store files in Epilot for advantages such as resizing, versioning, easy access, and maintenance.\n"
+          },
+          "legal_footnotes": {
+            "type": "string",
+            "description": "Legal footnotes for the product."
+          },
+          "additional_notes": {
+            "type": "array",
+            "description": "Additional notes for the product.",
+            "items": {
+              "type": "string"
+            }
+          },
+          "recommendation_settings": {
+            "type": "object",
+            "description": "Recommendation settings for the product.",
+            "properties": {
+              "is_recommended": {
+                "type": "boolean",
+                "description": "Flag to enable or disable the recommendation for this product."
+              },
+              "recommended_label": {
+                "type": "string",
+                "description": "Label to display when the product is recommended."
+              },
+              "recommended_color": {
+                "type": "string",
+                "description": "Color to display when the product is recommended."
+              },
+              "recommended_label_color": {
+                "type": "string",
+                "description": "Color of the recommended label."
+              }
+            },
+            "example": {
+              "is_recommended": true,
+              "recommended_label": "Best Value",
+              "recommended_color": "#00FF00",
+              "recommended_label_color": "#FFFFFF"
+            }
+          },
+          "price": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ExternalSimplePrice"
+              },
+              {
+                "$ref": "#/components/schemas/ExternalCompositePrice"
+              }
+            ]
           }
         },
         "required": [
-          "pricing_details",
-          "_meta"
+          "price",
+          "name",
+          "id"
         ]
       },
       "ExternalPriceFees": {

package/package.json

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