@epilot/pricing-client 3.17.8 → 3.18.0

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

@@ -91,20 +91,6 @@ declare namespace Components {
             products: string[];
             filters: /* Availability filters dimensions */ AvailabilityFilters;
         }
-        export interface AvailabilityDate {
-            /**
-             * The availability interval start date
-             * example:
-             * 2017-07-21
-             */
-            available_start_date?: string; // date
-            /**
-             * The availability interval end date
-             * example:
-             * 2017-07-21
-             */
-            available_end_date?: string; // date
-        }
         /**
          * Availability filters dimensions
          */
@@ -469,51 +455,6 @@ declare namespace Components {
             password: string;
         }
         export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
-        /**
-         * Supports shopping for products and services until ready for checkout.
-         */
-        export interface Cart {
-            /**
-             * Total of all items before (discounts or) taxes are applied.
-             */
-            amount_subtotal?: number;
-            /**
-             * Total of all items before (discounts or) taxes are applied, as a string with all the decimal places.
-             */
-            amount_subtotal_decimal?: string;
-            /**
-             * Total of all items after (discounts and) taxes are applied.
-             */
-            amount_total?: number;
-            /**
-             * Total of all items after (discounts and) taxes are applied, as a string with all the decimal places.
-             */
-            amount_total_decimal?: string;
-            /**
-             * The cart identifier
-             */
-            id?: string;
-            /**
-             * The user's Organization Id the cart belongs to
-             */
-            org_id?: string;
-            /**
-             * The status of the Cart:
-             * - open - the cart checkout is still in progress. Payment processing has not started
-             * - complete - the cart checkout is complete. Payment processing may still be in progress
-             * - expired - the cart checkout has expired. No further processing will occur
-             *
-             */
-            status?: "open" | "complete" | "expired";
-            customer?: Customer;
-            billing_address?: Address;
-            delivery_address?: Address;
-            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
-            line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
-            total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
-            created_at?: string; // date-time
-            updated_at?: string; // date-time
-        }
         /**
          * A valid cart payload from a client.
          */
@@ -1039,6 +980,105 @@ 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 computed static price
+             */
+            amount_static?: number;
+            /**
+             * The computed static price as decimal
+             */
+            amount_static_decimal?: any;
+            /**
+             * The computed variable price
+             */
+            amount_variable?: number;
+            /**
+             * The computed variable price as decimal
+             */
+            amount_variable_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 {
+            /**
+             * The static price breakdown
+             */
+            static?: /* The computed price components */ ComputedPriceComponents;
+            /**
+             * The variable price breakdown
+             */
+            variable?: /* The computed price components */ ComputedPriceComponents;
+        }
+        /**
+         * The computed price components
+         */
+        export interface ComputedPriceComponents {
+            [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
@@ -1059,35 +1099,6 @@ declare namespace Components {
             phone?: string;
         }
         export type EntityId = string; // uuid
-        /**
-         * example:
-         * {
-         *   "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
-         *   "_org": "123",
-         *   "_schema": "contact",
-         *   "_tags": [
-         *     "example",
-         *     "mock"
-         *   ],
-         *   "_created_at": "2021-02-09T12:41:43.662Z",
-         *   "_updated_at": "2021-02-09T12:41:43.662Z"
-         * }
-         */
-        export interface EntityItem {
-            _id: EntityId /* uuid */;
-            /**
-             * Title of entity
-             */
-            _title: string;
-            /**
-             * Organization Id the entity belongs to
-             */
-            _org: string;
-            _schema: string;
-            _tags?: string[];
-            _created_at: string; // date-time
-            _updated_at: string; // date-time
-        }
         export interface EntityRelation {
             [name: string]: any;
             entity_id?: string;
@@ -2338,51 +2349,6 @@ declare namespace Components {
             display_mode?: PriceTierDisplayMode;
         }
         export type PriceTierDisplayMode = "hidden" | "on_request";
-        /**
-         * The result from the calculation of a set of price items.
-         */
-        export interface PricingDetails {
-            items?: (/**
-             * Represents a price item
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price-item"
-             * }
-             */
-            PriceItem | /**
-             * Represents a composite price input to the pricing library.
-             * example:
-             * {
-             *   "$ref": "#/components/examples/price-item"
-             * }
-             */
-            CompositePriceItem)[];
-            /**
-             * Total of all items before (discounts or) taxes are applied.
-             */
-            amount_subtotal?: number;
-            /**
-             * Total of all items after (discounts and) taxes are applied.
-             */
-            amount_total?: number;
-            /**
-             * The unit gross amount value.
-             */
-            unit_amount_gross?: number;
-            /**
-             * This is the sum of all the price item tax amounts.
-             */
-            amount_tax?: number;
-            total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
-            currency?: /**
-             * 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 product entity
          * example:
@@ -2569,35 +2535,6 @@ declare namespace Components {
              */
             amount_tax?: number;
         }
-        /**
-         * An amount associated with a specific recurrence and tax.
-         */
-        export interface RecurrenceAmountWithTax {
-            /**
-             * The price type.
-             */
-            type?: string;
-            /**
-             * The price billing period.
-             */
-            billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
-            /**
-             * Total of all items after (discounts and) taxes are applied.
-             */
-            amount_total: number;
-            /**
-             * Total of all items before (discounts or) taxes are applied.
-             */
-            amount_subtotal: number;
-            /**
-             * Total of all items taxes, with same recurrence.
-             */
-            amount_tax?: number;
-            /**
-             * Tax
-             */
-            tax?: /* A tax amount associated with a specific tax rate. */ TaxAmountBreakdown;
-        }
         export type SalesTax = "nontaxable" | "reduced" | "standard";
         export type SaveIntegrationCredentialsParams = /* The basic auth credentials */ BasicAuthCredentials;
         /**
@@ -2653,7 +2590,7 @@ declare namespace Components {
             /**
              * The street name
              */
-            name: string;
+            street: string;
         }
         /**
          * the tax configuration
@@ -2821,10 +2758,6 @@ declare namespace Components {
                  * The aggregated price items tax amount per rate.
                  */
                 recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
-                /**
-                 * The aggregated price items recurrences by tax rate.
-                 */
-                recurrencesByTax?: (/* An amount associated with a specific recurrence and tax. */ RecurrenceAmountWithTax)[];
             };
         }
         /**
@@ -2916,6 +2849,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 +3170,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 +3333,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 +3341,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