@epilot/pricing-client 3.38.0 → 3.39.0

package/dist/openapi.d.ts

@@ -216,6 +216,110 @@ declare namespace Components {
                 };
             }[];
         }
+        /**
+         * The coupon configuration
+         * example:
+         * {
+         *   "_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 BaseCoupon {
+            [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;
+            description?: string;
+            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;
+            /**
+             * 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;
+            /**
+             * 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[];
+        }
         /**
          * Represents a price item
          * example:
@@ -2217,15 +2321,125 @@ declare namespace Components {
              */
             requires_promo_code?: boolean;
             /**
-             * The promo codes associated with the coupon
+             * 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[];
+            promo_codes?: /**
+             * example:
+             * {
+             *   "id": "123e4567-e89b-12d3-a456-426614174000",
+             *   "code": "123456",
+             *   "has_usage_limit": true,
+             *   "usage_limit": 10
+             * }
              */
-            promo_codes?: PromoCode[];
+            PromoCode[];
             /**
              * Map of ids of promo codes with their usage count
              */
             promo_code_usage?: {
                 [name: string]: number;
             };
+        }
+        /**
+         * The coupon configuration
+         * example:
+         * {
+         *   "_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 CouponWithoutPromoCodes {
+            [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;
+            description?: string;
+            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;
+            /**
+             * 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;
             /**
              * The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.
              */
@@ -4318,6 +4532,15 @@ declare namespace Components {
             _updated_at?: string;
         }
         export type ProductCategory = "power" | "gas";
+        /**
+         * example:
+         * {
+         *   "id": "123e4567-e89b-12d3-a456-426614174000",
+         *   "code": "123456",
+         *   "has_usage_limit": true,
+         *   "usage_limit": 10
+         * }
+         */
         export interface PromoCode {
             /**
              * The id of the promo code
@@ -4336,6 +4559,42 @@ declare namespace Components {
              */
             usage_limit?: number | null;
         }
+        /**
+         * The result from the validation of a set of promo codes.
+         */
+        export interface PromoCodeValidationResponse {
+            matched_coupons?: /**
+             * The coupon configuration
+             * example:
+             * {
+             *   "_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"
+             *       }
+             *     ]
+             *   }
+             * }
+             */
+            BaseCoupon[];
+        }
         /**
          * The provider entity
          */
@@ -5128,6 +5387,22 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $ValidatePromoCodes {
+        export interface RequestBody {
+            /**
+             * The list of coupon ids to unlock with promo codes
+             */
+            coupon_ids?: string[];
+            /**
+             * The list of promo codes to validate against the coupons
+             */
+            promo_codes?: string[];
+        }
+        namespace Responses {
+            export type $200 = /* The result from the validation of a set of promo codes. */ Components.Schemas.PromoCodeValidationResponse;
+            export type $400 = Components.Schemas.Error;
+        }
+    }
     namespace CreateOrder {
         export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
         namespace Responses {
@@ -5236,6 +5511,16 @@ export interface OperationMethods {
     data?: Paths.$PrivateSearchCatalog.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$PrivateSearchCatalog.Responses.$200>
+  /**
+   * $validatePromoCodes - validatePromoCodes
+   * 
+   * Validate a list of promo codes against a list of coupons
+   */
+  '$validatePromoCodes'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.$ValidatePromoCodes.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$ValidatePromoCodes.Responses.$200>
   /**
    * $availabilityCheck - availabilityCheck
    * 
@@ -5412,6 +5697,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$PrivateSearchCatalog.Responses.$200>
   }
+  ['/v1/validate-promo-codes']: {
+    /**
+     * $validatePromoCodes - validatePromoCodes
+     * 
+     * Validate a list of promo codes against a list of coupons
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.$ValidatePromoCodes.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$ValidatePromoCodes.Responses.$200>
+  }
   ['/v1/public/availability:check']: {
     /**
      * $availabilityCheck - availabilityCheck
@@ -5531,6 +5828,7 @@ export type AvailabilityDate = Components.Schemas.AvailabilityDate;
 export type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
 export type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
 export type AvailabilityResult = Components.Schemas.AvailabilityResult;
+export type BaseCoupon = Components.Schemas.BaseCoupon;
 export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
 export type BasePriceItemDto = Components.Schemas.BasePriceItemDto;
@@ -5557,6 +5855,7 @@ export type ComputedPriceBreakdown = Components.Schemas.ComputedPriceBreakdown;
 export type ComputedPriceComponents = Components.Schemas.ComputedPriceComponents;
 export type ConsumptionTypeGetAg = Components.Schemas.ConsumptionTypeGetAg;
 export type Coupon = Components.Schemas.Coupon;
+export type CouponWithoutPromoCodes = Components.Schemas.CouponWithoutPromoCodes;
 export type Currency = Components.Schemas.Currency;
 export type Customer = Components.Schemas.Customer;
 export type DynamicTariffInterval = Components.Schemas.DynamicTariffInterval;
@@ -5604,6 +5903,7 @@ export type PricingModel = Components.Schemas.PricingModel;
 export type Product = Components.Schemas.Product;
 export type ProductCategory = Components.Schemas.ProductCategory;
 export type PromoCode = Components.Schemas.PromoCode;
+export type PromoCodeValidationResponse = Components.Schemas.PromoCodeValidationResponse;
 export type Provider = Components.Schemas.Provider;
 export type RecurrenceAmount = Components.Schemas.RecurrenceAmount;
 export type RecurrenceAmountDto = Components.Schemas.RecurrenceAmountDto;

package/dist/openapi.json

@@ -24,6 +24,10 @@
       "name": "Catalog API",
       "description": "Provides a way to query the entire catalog of products and prices.\n"
     },
+    {
+      "name": "Promo Codes API",
+      "description": "This API enables the validation of promo codes within journeys, their uniqueness and availability\n"
+    },
     {
       "name": "Availability API",
       "description": "Provides endpoints for querying products availability by a set of predefined dimensions.\n"
@@ -867,6 +871,105 @@
         }
       }
     },
+    "/v1/validate-promo-codes": {
+      "post": {
+        "description": "Validate a list of promo codes against a list of coupons",
+        "summary": "validatePromoCodes",
+        "operationId": "$validatePromoCodes",
+        "tags": [
+          "Promo Codes API"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "properties": {
+                  "coupon_ids": {
+                    "type": "array",
+                    "description": "The list of coupon ids to unlock with promo codes",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "promo_codes": {
+                    "type": "array",
+                    "description": "The list of promo codes to validate against the coupons",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "examples": {
+                "Find coupons matching codes": {
+                  "value": {
+                    "coupon_ids": [
+                      "81b8e841-5926-4a73-ac77-6607c1037b65",
+                      "45964a30-1a42-4e59-9362-7d954baf4ea1"
+                    ],
+                    "promo_codes": [
+                      "ABC",
+                      "DEF"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Pricing details result",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PromoCodeValidationResponse"
+                },
+                "example": {
+                  "matched_coupons": [
+                    {
+                      "name": "Coupon with promo-codes",
+                      "type": "fixed",
+                      "percentage_value": null,
+                      "fixed_value": 10,
+                      "fixed_value_currency": "EUR",
+                      "fixed_value_decimal": "10.00",
+                      "category": "discount",
+                      "cashback_period": null,
+                      "active": true,
+                      "_schema": "coupon",
+                      "requires_promo_code": true,
+                      "_id": "81b8e841-5926-4a73-ac77-6607c1037b65",
+                      "_org": "739224",
+                      "_owners": [
+                        {
+                          "org_id": "739224",
+                          "user_id": "11000622"
+                        }
+                      ],
+                      "_created_at": "2025-01-29T15:46:41.014Z",
+                      "_updated_at": "2025-01-29T15:46:41.014Z",
+                      "_title": "Coupon with promo-codes"
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/public/availability:check": {
       "post": {
         "description": "The availability check endpoint",
@@ -4573,6 +4676,18 @@
           }
         }
       },
+      "PromoCodeValidationResponse": {
+        "type": "object",
+        "description": "The result from the validation of a set of promo codes.",
+        "properties": {
+          "matched_coupons": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/BaseCoupon"
+            }
+          }
+        }
+      },
       "PricingDetailsResponse": {
         "type": "object",
         "description": "The result from the calculation of a set of price items.",
@@ -5051,7 +5166,7 @@
           }
         }
       },
-      "Coupon": {
+      "BaseCoupon": {
         "type": "object",
         "description": "The coupon configuration",
         "additionalProperties": true,
@@ -5160,20 +5275,6 @@
             "type": "boolean",
             "description": "Whether the coupon requires a promo code to be applied"
           },
-          "promo_codes": {
-            "type": "array",
-            "description": "The promo codes associated with the coupon",
-            "items": {
-              "$ref": "#/components/schemas/PromoCode"
-            }
-          },
-          "promo_code_usage": {
-            "type": "object",
-            "additionalProperties": {
-              "type": "number"
-            },
-            "description": "Map of ids of promo codes with their usage count"
-          },
           "prices": {
             "description": "The prices associated with the coupon. Will hold price entities if hydrated, relations otherwise.",
             "oneOf": [
@@ -5224,6 +5325,36 @@
           }
         }
       },
+      "Coupon": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseCoupon"
+          }
+        ],
+        "type": "object",
+        "properties": {
+          "promo_codes": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PromoCode"
+            }
+          },
+          "promo_code_usage": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "number"
+            },
+            "description": "Map of ids of promo codes with their usage count"
+          }
+        }
+      },
+      "CouponWithoutPromoCodes": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseCoupon"
+          }
+        ]
+      },
       "PromoCode": {
         "type": "object",
         "required": [
@@ -5248,6 +5379,12 @@
             "nullable": true,
             "description": "The usage limit of the promo code"
           }
+        },
+        "example": {
+          "id": "123e4567-e89b-12d3-a456-426614174000",
+          "code": "123456",
+          "has_usage_limit": true,
+          "usage_limit": 10
         }
       },
       "PriceTier": {

package/package.json

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