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

package/dist/openapi.d.ts

@@ -357,6 +357,70 @@ declare namespace Components {
              */
             Price[];
         }
+        /**
+         * The coupon configuration
+         */
+        export interface BaseCouponCommon {
+            [name: string]: any;
+            _id: EntityId /* uuid */;
+            /**
+             * The auto-generated title for the title
+             */
+            _title: string;
+            /**
+             * Organization Id the entity belongs to
+             */
+            _org: string;
+            /**
+             * The schema of the entity, for coupons it is always `coupon`
+             */
+            _schema: "coupon";
+            _tags?: string[];
+            /**
+             * The creation date for the opportunity
+             */
+            _created_at: string; // date-time
+            /**
+             * The date the coupon was last updated
+             */
+            _updated_at: string; // date-time
+            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 | null;
+            /**
+             * Use if type is set to fixed. The fixed amount in cents to be discounted, represented as a whole integer.
+             */
+            fixed_value?: number;
+            /**
+             * Use if type is set to fixed. The unit amount in cents to be discounted, represented as a decimal string with at most 12 decimal places.
+             */
+            fixed_value_decimal?: string;
+            /**
+             * 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. */ /**
+             * 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 cashback period, for now it's limited to either 0 months or 12 months
+             */
+            cashback_period?: "0" | "12";
+            active?: boolean;
+            /**
+             * Whether the coupon requires a promo code to be applied
+             */
+            requires_promo_code?: boolean;
+        }
         export interface BaseMarketPriceRecord {
             /**
              * Cost in Cents, e.g. 12.3 for 12,3 Cents = 0.123€.
@@ -721,7 +785,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ 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'.
              */
@@ -1059,7 +1123,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ CouponItem)[];
         }
         export interface BasicAuthCredentials {
             /**
@@ -1449,7 +1513,7 @@ declare namespace Components {
             /**
              * The flag for prices that contain price components.
              */
-            is_composite_price?: true;
+            is_composite_price: true;
             /**
              * The price creation date
              */
@@ -1817,7 +1881,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ 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'.
              */
@@ -1825,7 +1889,7 @@ declare namespace Components {
             /**
              * 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).
              */
@@ -2018,11 +2082,11 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ 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).
              */
@@ -2392,16 +2456,20 @@ declare namespace Components {
                 [name: string]: number;
             };
         }
+        /**
+         * The coupon configuration
+         */
         export interface CouponItem {
-            _id?: EntityId /* uuid */;
+            [name: string]: any;
+            _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`
              */
@@ -2410,12 +2478,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";
@@ -4092,7 +4160,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ 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'.
              */
@@ -4303,7 +4371,7 @@ declare namespace Components {
             /**
              * The coupons applicable to the price item
              */
-            _coupons?: (CouponItem)[];
+            _coupons?: (/* The coupon configuration */ CouponItem)[];
             /**
              * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
              */
@@ -6228,6 +6296,7 @@ export type AvailabilityResult = Components.Schemas.AvailabilityResult;
 export type AverageMarketPriceRecord = Components.Schemas.AverageMarketPriceRecord;
 export type AverageMarketPriceResult = Components.Schemas.AverageMarketPriceResult;
 export type BaseCoupon = Components.Schemas.BaseCoupon;
+export type BaseCouponCommon = Components.Schemas.BaseCouponCommon;
 export type BaseMarketPriceRecord = Components.Schemas.BaseMarketPriceRecord;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;

package/dist/openapi.json

@@ -3033,6 +3033,9 @@
         },
         "additionalProperties": true,
         "readOnly": true,
+        "required": [
+          "is_composite_price"
+        ],
         "properties": {
           "active": {
             "type": "boolean",
@@ -4571,6 +4574,9 @@
           },
           {
             "type": "object",
+            "required": [
+              "is_composite_price"
+            ],
             "properties": {
               "is_composite_price": {
                 "description": "The flag for prices that contain price components.",
@@ -4878,6 +4884,9 @@
         ],
         "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.",
@@ -5971,7 +5980,7 @@
           }
         }
       },
-      "BaseCoupon": {
+      "BaseCouponCommon": {
         "type": "object",
         "description": "The coupon configuration",
         "additionalProperties": true,
@@ -6085,7 +6094,17 @@
           "requires_promo_code": {
             "type": "boolean",
             "description": "Whether the coupon requires a promo code to be applied"
-          },
+          }
+        }
+      },
+      "BaseCoupon": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseCouponCommon"
+          }
+        ],
+        "properties": {
           "prices": {
             "description": "The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.",
             "oneOf": [
@@ -6161,112 +6180,11 @@
       },
       "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"
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseCouponCommon"
           }
-        }
+        ]
       },
       "CouponWithoutPromoCodes": {
         "allOf": [

package/package.json

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