@epilot/pricing-client 3.27.7 → 3.28.0

package/dist/openapi.d.ts

@@ -1204,6 +1204,7 @@ declare namespace Components {
              * The type of energy to compute the price
              */
             type: "power";
+            meter_type?: /* The meter type for power */ PowerMeterType;
         }
         export interface ComputePriceResult {
             /**
@@ -1921,6 +1922,10 @@ declare namespace Components {
                 [name: string]: any;
             };
         }
+        /**
+         * The meter type for power
+         */
+        export type PowerMeterType = "classic" | "smart" | "digital";
         /**
          * The price entity schema for simple pricing
          * example:
@@ -2129,6 +2134,7 @@ declare namespace Components {
             tariff_type?: TariffTypeGetAg;
             consumption_type?: ConsumptionTypeGetAg;
             concession_type?: /* The concession type for gas */ GasConcessionType;
+            meter_type?: /* The meter type for power */ PowerMeterType;
             /**
              * Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.
              *
@@ -3390,6 +3396,15 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $CalculatePricingDetails {
+        export interface RequestBody {
+            line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ Components.Schemas.PriceItemsDto;
+        }
+        namespace Responses {
+            export type $200 = /* The result from the calculation of a set of price items. */ Components.Schemas.PricingDetails;
+            export type $400 = Components.Schemas.Error;
+        }
+    }
     namespace $CheckoutCart {
         export interface HeaderParameters {
             "X-Ivy-Org-ID": Parameters.XIvyOrgID;
@@ -3421,33 +3436,6 @@ declare namespace Paths {
             export type $403 = Components.Schemas.Error;
         }
     }
-    namespace $CreateOpportunity {
-        export interface HeaderParameters {
-            "X-Ivy-Org-ID": Parameters.XIvyOrgID;
-        }
-        namespace Parameters {
-            export type XIvyOrgID = string;
-        }
-        export type RequestBody = /**
-         * The opportunity entity
-         * example:
-         * {
-         *   "$ref": "#/components/examples/opportunity"
-         * }
-         */
-        Components.Schemas.Opportunity;
-        namespace Responses {
-            export type $201 = /**
-             * The opportunity entity
-             * example:
-             * {
-             *   "$ref": "#/components/examples/opportunity"
-             * }
-             */
-            Components.Schemas.Opportunity;
-            export type $400 = Components.Schemas.Error;
-        }
-    }
     namespace $DeleteCredentials {
         namespace Parameters {
             export type IntegrationId = Components.Schemas.IntegrationId;
@@ -3665,6 +3653,16 @@ declare namespace Paths {
 }
 
 export interface OperationMethods {
+  /**
+   * $calculatePricingDetails - calculatePricingDetails
+   * 
+   * Compute price
+   */
+  '$calculatePricingDetails'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.$CalculatePricingDetails.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$CalculatePricingDetails.Responses.$200>
   /**
    * createOrder - createOrder
    * 
@@ -3806,23 +3804,21 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
-  /**
-   * $createOpportunity - createOpportunity
-   * 
-   * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
-   * 
-   * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
-   * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
-   * 
-   */
-  '$createOpportunity'(
-    parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
-    data?: Paths.$CreateOpportunity.RequestBody,
-    config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
 }
 
 export interface PathsDictionary {
+  ['/v1/pricing:compute']: {
+    /**
+     * $calculatePricingDetails - calculatePricingDetails
+     * 
+     * Compute price
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.$CalculatePricingDetails.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$CalculatePricingDetails.Responses.$200>
+  }
   ['/v1/order']: {
     /**
      * createOrder - createOrder
@@ -3990,22 +3986,6 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
   }
-  ['/v1/public/opportunity']: {
-    /**
-     * $createOpportunity - createOpportunity
-     * 
-     * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
-     * 
-     * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
-     * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
-     * 
-     */
-    'post'(
-      parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
-      data?: Paths.$CreateOpportunity.RequestBody,
-      config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
-  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>

package/dist/openapi.json

@@ -111,6 +111,82 @@
     }
   ],
   "paths": {
+    "/v1/pricing:compute": {
+      "post": {
+        "description": "Compute price",
+        "summary": "calculatePricingDetails",
+        "operationId": "$calculatePricingDetails",
+        "tags": [
+          "Order API"
+        ],
+        "requestBody": {
+          "required": false,
+          "content": {
+            "application/json": {
+              "schema": {
+                "properties": {
+                  "line_items": {
+                    "$ref": "#/components/schemas/PriceItemsDto"
+                  }
+                }
+              },
+              "examples": {
+                "Compute price": {
+                  "value": {
+                    "line_items": [
+                      {
+                        "product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
+                        "price_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
+                        "quantity": 2
+                      },
+                      {
+                        "product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
+                        "price_id": "2abe0c6f-63ef-417b-8c85-5546359382d9",
+                        "quantity": 1,
+                        "price_mappings": [
+                          {
+                            "price_id": "2abe0c6f-63ef-417b-8c85-5546359382d9",
+                            "frequency_unit": "one_time",
+                            "value": 2,
+                            "name": "Estimated consumption",
+                            "metadata": {
+                              "journey_title": "P&G",
+                              "step_name": "Number Inputs"
+                            }
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Pricing details result",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PricingDetails"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/order": {
       "post": {
         "description": "Create an order",
@@ -1353,102 +1429,6 @@
           }
         }
       }
-    },
-    "/v1/public/opportunity": {
-      "post": {
-        "deprecated": true,
-        "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": [
-          {},
-          {
-            "EpilotPublicAuth": []
-          }
-        ],
-        "tags": [
-          "Deprecated"
-        ],
-        "parameters": [
-          {
-            "in": "header",
-            "name": "X-Ivy-Org-ID",
-            "description": "The target Organization Id represented by the caller",
-            "schema": {
-              "type": "string"
-            },
-            "required": true
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/Opportunity"
-              },
-              "examples": {
-                "Opportunity containing one Order": {
-                  "value": {
-                    "billing_address": {
-                      "street": "sdf",
-                      "street_number": "1",
-                      "city": "Berlin",
-                      "postal_code": "12045",
-                      "country": "de",
-                      "additional_info": "adasd"
-                    },
-                    "delivery_address": {
-                      "street": "sdf",
-                      "street_number": "1",
-                      "city": "Berlin",
-                      "postal_code": "12045",
-                      "country": "de",
-                      "additional_info": "adasd"
-                    },
-                    "items": {
-                      "$relation": [
-                        {
-                          "entity_id": "c8dbe8f3-28b6-4d77-aae8-47bc24a2532f",
-                          "_tags": [
-                            "journey"
-                          ]
-                        }
-                      ]
-                    },
-                    "_tags": [
-                      "journey",
-                      "ORWNr4iCN"
-                    ]
-                  }
-                }
-              }
-            }
-          }
-        },
-        "responses": {
-          "201": {
-            "description": "The new Opportunity.",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Opportunity"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid payload",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Error"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "components": {
@@ -2809,6 +2789,9 @@
                 "enum": [
                   "power"
                 ]
+              },
+              "meter_type": {
+                "$ref": "#/components/schemas/PowerMeterType"
               }
             },
             "description": "The compute price payload for power"
@@ -2893,6 +2876,15 @@
           "special"
         ]
       },
+      "PowerMeterType": {
+        "type": "string",
+        "description": "The meter type for power",
+        "enum": [
+          "classic",
+          "smart",
+          "digital"
+        ]
+      },
       "ComputedPriceBreakdown": {
         "type": "object",
         "description": "Price breakdown",
@@ -4672,6 +4664,13 @@
               }
             ]
           },
+          "meter_type": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/PowerMeterType"
+              }
+            ]
+          },
           "markup_tiers": {
             "description": "Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee.\n",
             "type": "array",

package/package.json

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