@epilot/pricing-client 3.17.8 → 3.17.9

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=i(t(240));r.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}]}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/public/opportunity":{"post":{"deprecated":true,"operationId":"$createOpportunity","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}}},"components":{}}')}},r={},t=function t(i){var a=r[i];if(void 0!==a)return a.exports;var n=r[i]={exports:{}};return e[i].call(n.exports,n,n.exports,t),n.exports}(914),i=exports;for(var a in t)i[a]=t[a];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={914:function(e,r,t){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=i(t(240));r.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://pricing-api.sls.epilot.io"}],"paths":{"/v1/order":{"post":{"operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/order/{id}":{"put":{"operationId":"putOrder","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/cart:checkout":{"post":{"operationId":"$checkoutCart","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/catalog":{"post":{"operationId":"$searchCatalog","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/availability:check":{"post":{"operationId":"$availabilityCheck","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/validate-availability/{id}":{"get":{"operationId":"$validateAvailabilityFile","parameters":[{"in":"path","name":"id","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}]}},"/v1/public/integration/{integrationId}/providers:search":{"post":{"operationId":"$searchProviders","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/streets:search":{"post":{"operationId":"$searchStreets","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}},"/v1/public/integration/{integrationId}/compute-price":{"post":{"operationId":"$computePrice","parameters":[{"in":"header","name":"X-Epilot-Org-ID","required":true},{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true}]}},"/v1/public/opportunity":{"post":{"deprecated":true,"operationId":"$createOpportunity","parameters":[{"in":"header","name":"X-Ivy-Org-ID","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}}}}},"components":{}}')}},r={},t=function t(i){var a=r[i];if(void 0!==a)return a.exports;var n=r[i]={exports:{}};return e[i].call(n.exports,n,n.exports,t),n.exports}(914),i=exports;for(var a in t)i[a]=t[a];t.__esModule&&Object.defineProperty(i,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -156,6 +156,28 @@
         }
       }
     },
+    "/v1/public/integration/{integrationId}/compute-price": {
+      "post": {
+        "operationId": "$computePrice",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "integrationId",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
+    },
     "/v1/integration/{integrationId}/credentials": {
       "get": {
         "operationId": "$getCredentials",

package/dist/openapi.d.ts

@@ -1039,6 +1039,76 @@ declare namespace Components {
              */
             CompositePrice;
         }
+        /**
+         * The compute price payload
+         */
+        export interface ComputePriceParams {
+            /**
+             * The postal code to search for providers
+             */
+            postal_code: string;
+            /**
+             * The monthly consumption to compute the price in kWh
+             */
+            consumption: number;
+            /**
+             * The association id
+             */
+            association_id?: string;
+            /**
+             * The product type
+             */
+            type: "power" | "gas";
+            /**
+             * The billing period (defaults to monthly)
+             */
+            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+        }
+        export interface ComputePriceResult {
+            /**
+             * The computed total price
+             */
+            amount_total: number;
+            /**
+             * The computed total price as decimal
+             */
+            amount_total_decimal: string;
+            /**
+             * The currency of the computed price (three-letter ISO currency code)
+             */
+            currency: /* The currency of the computed price (three-letter ISO currency code) */ /**
+             * 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 billing period
+             */
+            billing_period: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
+            breakdown: /* Price breakdown */ ComputedPriceBreakdown;
+        }
+        /**
+         * The computed price
+         */
+        export interface ComputedBasePrice {
+            /**
+             * The computed price
+             */
+            amount: number;
+            /**
+             * The computed price as decimal
+             */
+            amount_decimal: string;
+        }
+        /**
+         * Price breakdown
+         */
+        export interface ComputedPriceBreakdown {
+            [name: string]: /* The computed price */ ComputedBasePrice;
+        }
         /**
          * 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
@@ -2916,6 +2986,24 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $ComputePrice {
+        export interface HeaderParameters {
+            "X-Epilot-Org-ID": Parameters.XEpilotOrgID;
+        }
+        namespace Parameters {
+            export type IntegrationId = Components.Schemas.IntegrationId;
+            export type XEpilotOrgID = string;
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId;
+        }
+        export type RequestBody = /* The compute price payload */ Components.Schemas.ComputePriceParams;
+        namespace Responses {
+            export type $200 = Components.Schemas.ComputePriceResult;
+            export type $400 = Components.Schemas.Error;
+            export type $403 = Components.Schemas.Error;
+        }
+    }
     namespace $CreateOpportunity {
         export interface HeaderParameters {
             "X-Ivy-Org-ID": Parameters.XIvyOrgID;
@@ -3219,13 +3307,23 @@ export interface OperationMethods {
   /**
    * $searchStreets - searchStreets
    * 
-   * Returns the list of streets available for a given postal_code and city
+   * Returns the list of streets available for a given postal code and city
    */
   '$searchStreets'(
     parameters?: Parameters<Paths.$SearchStreets.PathParameters & Paths.$SearchStreets.HeaderParameters> | null,
     data?: Paths.$SearchStreets.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$SearchStreets.Responses.$200>
+  /**
+   * $computePrice - computePrice
+   * 
+   * Returns the price for a given product type based on location and consumption
+   */
+  '$computePrice'(
+    parameters?: Parameters<Paths.$ComputePrice.PathParameters & Paths.$ComputePrice.HeaderParameters> | null,
+    data?: Paths.$ComputePrice.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$ComputePrice.Responses.$200>
   /**
    * $getCredentials - getCredentials
    * 
@@ -3372,7 +3470,7 @@ export interface PathsDictionary {
     /**
      * $searchStreets - searchStreets
      * 
-     * Returns the list of streets available for a given postal_code and city
+     * Returns the list of streets available for a given postal code and city
      */
     'post'(
       parameters?: Parameters<Paths.$SearchStreets.PathParameters & Paths.$SearchStreets.HeaderParameters> | null,
@@ -3380,6 +3478,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$SearchStreets.Responses.$200>
   }
+  ['/v1/public/integration/{integrationId}/compute-price']: {
+    /**
+     * $computePrice - computePrice
+     * 
+     * Returns the price for a given product type based on location and consumption
+     */
+    'post'(
+      parameters?: Parameters<Paths.$ComputePrice.PathParameters & Paths.$ComputePrice.HeaderParameters> | null,
+      data?: Paths.$ComputePrice.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$ComputePrice.Responses.$200>
+  }
   ['/v1/integration/{integrationId}/credentials']: {
     /**
      * $getCredentials - getCredentials

package/dist/openapi.json

@@ -918,7 +918,7 @@
     },
     "/v1/public/integration/{integrationId}/streets:search": {
       "post": {
-        "description": "Returns the list of streets available for a given postal_code and city",
+        "description": "Returns the list of streets available for a given postal code and city",
         "operationId": "$searchStreets",
         "security": [],
         "parameters": [
@@ -1011,6 +1011,107 @@
         }
       }
     },
+    "/v1/public/integration/{integrationId}/compute-price": {
+      "post": {
+        "description": "Returns the price for a given product type based on location and consumption",
+        "operationId": "$computePrice",
+        "security": [],
+        "parameters": [
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "description": "The target Organization Id represented by the caller",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "example": 739224
+          },
+          {
+            "in": "path",
+            "name": "integrationId",
+            "description": "The integration identifier",
+            "schema": {
+              "$ref": "#/components/schemas/IntegrationId"
+            },
+            "required": true,
+            "example": "getag"
+          }
+        ],
+        "summary": "computePrice",
+        "tags": [
+          "External Integrations API"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ComputePriceParams"
+              },
+              "examples": {
+                "Compute price": {
+                  "value": {
+                    "type": "power",
+                    "billing_period": "monthly",
+                    "postal_code": "04109",
+                    "consumption": 3500,
+                    "association_id": "123456789"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The compute price response payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ComputePriceResult"
+                },
+                "examples": {
+                  "Response of computed price": {
+                    "value": {
+                      "amount_total": 100,
+                      "amount_total_decimal": "100.00",
+                      "currency": "EUR",
+                      "billing_period": "monthly",
+                      "breakdown": {
+                        "maintenance_fee": {
+                          "amount": 10,
+                          "amount_decimal": "10.00"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden, no credentials found for the given integration / organization",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/integration/{integrationId}/credentials": {
       "get": {
         "description": "Gets the credentials for a given integration / organization",
@@ -2489,6 +2590,118 @@
       "SaveIntegrationCredentialsParams": {
         "$ref": "#/components/schemas/BasicAuthCredentials"
       },
+      "ComputePriceParams": {
+        "description": "The compute price payload",
+        "type": "object",
+        "properties": {
+          "postal_code": {
+            "description": "The postal code to search for providers",
+            "type": "string"
+          },
+          "consumption": {
+            "description": "The monthly consumption to compute the price in kWh",
+            "type": "number"
+          },
+          "association_id": {
+            "description": "The association id",
+            "type": "string"
+          },
+          "type": {
+            "description": "The product type",
+            "type": "string",
+            "enum": [
+              "power",
+              "gas"
+            ]
+          },
+          "billing_period": {
+            "description": "The billing period (defaults to monthly)",
+            "type": "string",
+            "enum": [
+              "weekly",
+              "monthly",
+              "every_quarter",
+              "every_6_months",
+              "yearly",
+              "one_time"
+            ],
+            "default": "monthly"
+          }
+        },
+        "required": [
+          "type",
+          "postal_code",
+          "consumption"
+        ]
+      },
+      "ComputedBasePrice": {
+        "type": "object",
+        "description": "The computed price",
+        "properties": {
+          "amount": {
+            "description": "The computed price",
+            "type": "number"
+          },
+          "amount_decimal": {
+            "description": "The computed price as decimal",
+            "type": "string"
+          }
+        },
+        "required": [
+          "amount",
+          "amount_decimal"
+        ]
+      },
+      "ComputedPriceBreakdown": {
+        "type": "object",
+        "description": "Price breakdown",
+        "additionalProperties": {
+          "$ref": "#/components/schemas/ComputedBasePrice"
+        }
+      },
+      "ComputePriceResult": {
+        "type": "object",
+        "properties": {
+          "amount_total": {
+            "description": "The computed total price",
+            "type": "number"
+          },
+          "amount_total_decimal": {
+            "description": "The computed total price as decimal",
+            "type": "string"
+          },
+          "currency": {
+            "description": "The currency of the computed price (three-letter ISO currency code)",
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/Currency"
+              }
+            ]
+          },
+          "billing_period": {
+            "description": "The billing period",
+            "type": "string",
+            "enum": [
+              "weekly",
+              "monthly",
+              "every_quarter",
+              "every_6_months",
+              "yearly",
+              "one_time"
+            ]
+          },
+          "breakdown": {
+            "$ref": "#/components/schemas/ComputedPriceBreakdown"
+          }
+        },
+        "required": [
+          "amount_total",
+          "amount_total_decimal",
+          "currency",
+          "billing_period",
+          "breakdown"
+        ]
+      },
       "BasicAuthCredentials": {
         "description": "The basic auth credentials",
         "type": "object",

package/package.json

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