@epilot/pricing-client 3.26.1 → 3.27.1

package/dist/openapi.d.ts

@@ -608,18 +608,7 @@ declare namespace Components {
          *   "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
          *   "sort": "description ASC",
          *   "from": 0,
-         *   "size": 200,
-         *   "availability": {
-         *     "location": {
-         *       "postal_code": "57008,",
-         *       "city": "Cologne,",
-         *       "street": "Media Park,",
-         *       "street_number": "8a"
-         *     },
-         *     "available_date": {
-         *       "value": "2022-05-01"
-         *     }
-         *   }
+         *   "size": 200
          * }
          */
         export interface CatalogSearch {
@@ -1094,6 +1083,10 @@ declare namespace Components {
              * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
              */
             item_components?: /* Represents a price input to the pricing library. */ PriceItemDto[];
+            /**
+             * The ids of the price components that should be selected for the price calculation.
+             */
+            selected_price_component_ids?: string[];
             _price?: /**
              * The price entity schema for dynamic pricing
              * example:
@@ -1402,6 +1395,14 @@ declare namespace Components {
         }
         export type IntegrationCredentialsResult = /* The basic auth credentials */ BasicAuthCredentials;
         export type IntegrationId = "enet" | "getag";
+        /**
+         * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
+         * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
+         * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unitary 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.
+         *
+         */
+        export type MarkupPricingModel = "per_unit" | "tiered_volume" | "tiered_flatfee";
         /**
          * A set of key-value pairs used to store meta data information about an entity.
          */
@@ -1995,6 +1996,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;
+            get_ag?: PriceGetAg;
             /**
              * The price creation date
              */
@@ -2038,6 +2040,20 @@ declare namespace Components {
         }
         export interface PriceGetAg {
             category: string;
+            markup_pricing_model?: /**
+             * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.
+             * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
+             * - `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unitary 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.
+             *
+             */
+            MarkupPricingModel;
+            type?: TypeGetAg;
+            /**
+             * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
+             *
+             */
+            markup_tiers?: PriceTier[];
             markup_amount: number;
             markup_amount_decimal: string;
             markup_amount_net?: number;
@@ -2249,7 +2265,7 @@ declare namespace Components {
              * The price billing period.
              */
             billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
-            /**
+            pricing_model: /**
              * 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.
@@ -2258,7 +2274,7 @@ declare namespace Components {
              * - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
              *
              */
-            pricing_model: "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
+            PricingModel;
             tiers_details?: TierDetails[];
             get_ag?: PriceGetAg;
         }
@@ -2609,6 +2625,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;
+                get_ag?: PriceGetAg;
                 /**
                  * The price creation date
                  */
@@ -2727,6 +2744,16 @@ declare namespace Components {
              */
             Currency;
         }
+        /**
+         * 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.
+         * - `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.
+         *
+         */
+        export type PricingModel = "per_unit" | "tiered_graduated" | "tiered_volume" | "tiered_flatfee" | "external_getag";
         /**
          * The product entity
          * example:
@@ -3204,6 +3231,7 @@ declare namespace Components {
                 recurrencesByTax?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountWithTax)[];
             };
         }
+        export type TypeGetAg = "base_price" | "work_price";
         /**
          * The availability rule error
          */
@@ -3372,18 +3400,7 @@ declare namespace Paths {
          *   "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
          *   "sort": "description ASC",
          *   "from": 0,
-         *   "size": 200,
-         *   "availability": {
-         *     "location": {
-         *       "postal_code": "57008,",
-         *       "city": "Cologne,",
-         *       "street": "Media Park,",
-         *       "street_number": "8a"
-         *     },
-         *     "available_date": {
-         *       "value": "2022-05-01"
-         *     }
-         *   }
+         *   "size": 200
          * }
          */
         Components.Schemas.CatalogSearch;
@@ -3425,7 +3442,7 @@ declare namespace Paths {
     }
     namespace $SearchCatalog {
         export interface HeaderParameters {
-            "X-Ivy-Org-ID": Parameters.XIvyOrgID;
+            "X-Ivy-Org-ID"?: Parameters.XIvyOrgID;
             Authorization?: Parameters.Authorization;
         }
         namespace Parameters {
@@ -3439,18 +3456,7 @@ declare namespace Paths {
          *   "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
          *   "sort": "description ASC",
          *   "from": 0,
-         *   "size": 200,
-         *   "availability": {
-         *     "location": {
-         *       "postal_code": "57008,",
-         *       "city": "Cologne,",
-         *       "street": "Media Park,",
-         *       "street_number": "8a"
-         *     },
-         *     "available_date": {
-         *       "value": "2022-05-01"
-         *     }
-         *   }
+         *   "size": 200
          * }
          */
         Components.Schemas.CatalogSearch;

package/dist/openapi.json

@@ -495,7 +495,12 @@
         "description": "Checkouts a cart and executes the specified checkout `mode` process.\n\nA Checkout implicitly finalizes the provided cart (if not transient from a fast-checkout) and behaves in one of the following modes:\n- `create_order` (**default**): the payment happens at a later date or managed by 3rd-party CRM (SAP)\n- `create_invoice`: the payment happens on the online checkout (paypal, stripe, adyen)\n- `create_quote`: the checkout represents a price quote request\n\nFast checkout is also supported, by passing the Cart contents directly.\nWhen a fast checkout is performed the cart is considered transient and there is no cart persistance.\n\nIf the checkout `mode` is omitted, the `mode` will default to `create_order`.\n",
         "operationId": "$checkoutCart",
         "summary": "checkoutCart",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "tags": [
           "Cart API"
         ],
@@ -559,7 +564,12 @@
         "description": "Provides a querying functionalities over products and prices of the Catalog for a given organization.",
         "operationId": "$searchCatalog",
         "summary": "searchCatalog",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "tags": [
           "Catalog API"
         ],
@@ -568,10 +578,10 @@
             "in": "header",
             "name": "X-Ivy-Org-ID",
             "description": "The target Organization Id represented by the caller",
+            "example": 739224,
             "schema": {
               "type": "string"
-            },
-            "required": true
+            }
           },
           {
             "in": "header",
@@ -663,7 +673,12 @@
         "description": "The availability check endpoint",
         "operationId": "$availabilityCheck",
         "summary": "availabilityCheck",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "tags": [
           "Availability API"
         ],
@@ -859,7 +874,12 @@
       "post": {
         "description": "Returns the list of providers available based on a given location",
         "operationId": "$searchProviders",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "parameters": [
           {
             "in": "header",
@@ -967,7 +987,12 @@
       "post": {
         "description": "Returns the list of streets available for a given postal code and city",
         "operationId": "$searchStreets",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "parameters": [
           {
             "in": "header",
@@ -1062,7 +1087,12 @@
       "post": {
         "description": "Returns the price for a given product type based on location and consumption",
         "operationId": "$computePrice",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "parameters": [
           {
             "in": "header",
@@ -1330,7 +1360,12 @@
         "description": "This API is Deprecated. Please use the Entity API or Submission API to create opportunities.\n\nEnables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.\nThe `opportunity_number` can be used to universally identify an opportunity within epilot platform.\n",
         "operationId": "$createOpportunity",
         "summary": "createOpportunity",
-        "security": [],
+        "security": [
+          {},
+          {
+            "EpilotPublicAuth": []
+          }
+        ],
         "tags": [
           "Deprecated"
         ],
@@ -1422,6 +1457,12 @@
         "type": "http",
         "scheme": "bearer",
         "description": "Epilot Bearer Token"
+      },
+      "EpilotPublicAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "description": "Epilot Public Access Bearer Token",
+        "bearerFormat": "JWT"
       }
     },
     "schemas": {
@@ -2194,6 +2235,9 @@
               }
             ]
           },
+          "get_ag": {
+            "$ref": "#/components/schemas/PriceGetAg"
+          },
           "_created_at": {
             "description": "The price creation date",
             "type": "string"
@@ -2499,18 +2543,7 @@
           "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
           "sort": "description ASC",
           "from": 0,
-          "size": 200,
-          "availability": {
-            "location": {
-              "postal_code": "57008,",
-              "city": "Cologne,",
-              "street": "Media Park,",
-              "street_number": "8a"
-            },
-            "available_date": {
-              "value": "2022-05-01"
-            }
-          }
+          "size": 200
         },
         "required": [
           "q"
@@ -3294,6 +3327,14 @@
               "$ref": "#/components/schemas/PriceItemDto"
             }
           },
+          "selected_price_component_ids": {
+            "type": "array",
+            "description": "The ids of the price components that should be selected for the price calculation.",
+            "items": {
+              "type": "string",
+              "description": "The id of the price component"
+            }
+          },
           "_price": {
             "$ref": "#/components/schemas/CompositePrice"
           }
@@ -3752,15 +3793,7 @@
             ]
           },
           "pricing_model": {
-            "type": "string",
-            "description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `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.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `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.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
-            "enum": [
-              "per_unit",
-              "tiered_graduated",
-              "tiered_volume",
-              "tiered_flatfee",
-              "external_getag"
-            ]
+            "$ref": "#/components/schemas/PricingModel"
           },
           "tiers_details": {
             "type": "array",
@@ -4512,12 +4545,52 @@
           "on_request"
         ]
       },
+      "PricingModel": {
+        "type": "string",
+        "description": "Describes how to compute the price per period. Either `per_unit`, `tiered_graduated` or `tiered_volume`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `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.\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.\n- `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.\n- `external_getag` indicates that the price is influenced by aquisition fees provided by GetAG.\n",
+        "enum": [
+          "per_unit",
+          "tiered_graduated",
+          "tiered_volume",
+          "tiered_flatfee",
+          "external_getag"
+        ]
+      },
+      "MarkupPricingModel": {
+        "type": "string",
+        "description": "Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`.\n- `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity\n- `tiered_volume` indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unitary price for all purchased units.\n- `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.\n",
+        "enum": [
+          "per_unit",
+          "tiered_volume",
+          "tiered_flatfee"
+        ]
+      },
+      "TypeGetAg": {
+        "type": "string",
+        "enum": [
+          "base_price",
+          "work_price"
+        ]
+      },
       "PriceGetAg": {
         "type": "object",
         "properties": {
           "category": {
             "type": "string"
           },
+          "markup_pricing_model": {
+            "$ref": "#/components/schemas/MarkupPricingModel"
+          },
+          "type": {
+            "$ref": "#/components/schemas/TypeGetAg"
+          },
+          "markup_tiers": {
+            "description": "Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.\n",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/PriceTier"
+            }
+          },
           "markup_amount": {
             "type": "number"
           },

package/package.json

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