@epilot/pricing-client 3.17.4 → 3.17.6

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={914:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var i=a(t(240));r.default=i.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/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(a){var i=r[a];if(void 0!==i)return i.exports;var o=r[a]={exports:{}};return e[a].call(o.exports,o,o.exports,t),o.exports}(914),a=exports;for(var i in t)a[i]=t[i];t.__esModule&&Object.defineProperty(a,"__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/integration/{integrationId}/credentials":{"get":{"operationId":"$getCredentials","parameters":[{"in":"path","name":"integrationId","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}]}},"/v1/integration/{integrationId}/credentials:save":{"put":{"operationId":"$saveCredentials","parameters":[{"in":"path","name":"integrationId","required":true},{"in":"header","name":"X-Epilot-Org-ID","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/integration/{integrationId}/credentials:delete":{"delete":{"operationId":"$deleteCredentials","parameters":[{"in":"path","name":"integrationId","required":true},{"in":"header","name":"X-Epilot-Org-ID","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

@@ -110,6 +110,108 @@
         ]
       }
     },
+    "/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
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "required": true
+          }
+        ]
+      }
+    },
+    "/v1/integration/{integrationId}/credentials:save": {
+      "put": {
+        "operationId": "$saveCredentials",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "integrationId",
+            "required": true
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {}
+          }
+        }
+      }
+    },
+    "/v1/integration/{integrationId}/credentials:delete": {
+      "delete": {
+        "operationId": "$deleteCredentials",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "integrationId",
+            "required": true
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "required": true
+          }
+        ]
+      }
+    },
     "/v1/public/opportunity": {
       "post": {
         "deprecated": true,

package/dist/openapi.d.ts

@@ -451,6 +451,23 @@ declare namespace Components {
                 _updated_at?: string;
             };
         }
+        /**
+         * The basic auth credentials
+         */
+        export interface BasicAuthCredentials {
+            /**
+             * The username
+             * example:
+             * username
+             */
+            username: string;
+            /**
+             * The password
+             * example:
+             * 123456
+             */
+            password: string;
+        }
         export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
         /**
          * Supports shopping for products and services until ready for checkout.
@@ -1109,6 +1126,13 @@ declare namespace Components {
             _title?: string;
             $relation?: EntityRelation;
         }
+        /**
+         * The credentials response payload
+         */
+        export interface IntegrationCredentialsResult {
+            schema?: /* The basic auth credentials */ BasicAuthCredentials;
+        }
+        export type IntegrationId = "enet" | "getag";
         /**
          * A set of key-value pairs used to store meta data information about an entity.
          */
@@ -2455,6 +2479,19 @@ declare namespace Components {
              */
             _updated_at?: string;
         }
+        /**
+         * The provider entity
+         */
+        export interface Provider {
+            /**
+             * The provider name
+             */
+            name: string;
+            /**
+             * The provider code
+             */
+            code: string;
+        }
         /**
          * An amount associated with a specific recurrence.
          */
@@ -2567,6 +2604,67 @@ declare namespace Components {
             tax?: /* A tax amount associated with a specific tax rate. */ TaxAmountBreakdown;
         }
         export type SalesTax = "nontaxable" | "reduced" | "standard";
+        /**
+         * The credentials request payload
+         */
+        export interface SaveIntegrationCredentialsParams {
+            schema?: /* The basic auth credentials */ BasicAuthCredentials;
+        }
+        /**
+         * A search providers payload
+         */
+        export interface SearchProvidersParams {
+            /**
+             * The provider type (power or gas)
+             */
+            type: "power" | "gas";
+            /**
+             * The postal code to search for providers
+             */
+            postal_code: string;
+            /**
+             * The city to search for providers
+             */
+            city?: string | null;
+            /**
+             * The street to search for providers
+             */
+            street?: string | null;
+            /**
+             * The street number to search for providers
+             */
+            street_number?: string | null;
+        }
+        /**
+         * The search providers payload
+         */
+        export type SearchProvidersResult = /* The provider entity */ Provider[];
+        /**
+         * A search streets payload
+         */
+        export interface SearchStreetsParams {
+            /**
+             * The postal code to search for providers
+             */
+            postal_code: string;
+            /**
+             * The city to search for providers
+             */
+            city: string | null;
+        }
+        /**
+         * The search providers payload
+         */
+        export type SearchStreetsResult = /* The street entity */ Street[];
+        /**
+         * The street entity
+         */
+        export interface Street {
+            /**
+             * The street name
+             */
+            name: string;
+        }
         /**
          * the tax configuration
          * example:
@@ -2730,7 +2828,7 @@ declare namespace Components {
                  */
                 taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmountBreakdown)[];
                 /**
-                 * The aggregated price items recurrences.
+                 * The aggregated price items tax amount per rate.
                  */
                 recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
                 /**
@@ -2855,6 +2953,58 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $DeleteCredentials {
+        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;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $400 = Components.Schemas.Error;
+        }
+    }
+    namespace $GetCredentials {
+        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;
+        }
+        namespace Responses {
+            export type $200 = /* The credentials response payload */ Components.Schemas.IntegrationCredentialsResult;
+            export type $400 = Components.Schemas.Error;
+            export type $404 = Components.Schemas.Error;
+        }
+    }
+    namespace $SaveCredentials {
+        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 credentials request payload */ Components.Schemas.SaveIntegrationCredentialsParams;
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $400 = Components.Schemas.Error;
+        }
+    }
     namespace $SearchCatalog {
         export interface HeaderParameters {
             "X-Ivy-Org-ID": Parameters.XIvyOrgID;
@@ -2906,6 +3056,42 @@ declare namespace Paths {
             export type $400 = Components.Schemas.Error;
         }
     }
+    namespace $SearchProviders {
+        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 = /* A search providers payload */ Components.Schemas.SearchProvidersParams;
+        namespace Responses {
+            export type $200 = /* The search providers payload */ Components.Schemas.SearchProvidersResult;
+            export type $400 = Components.Schemas.Error;
+            export type $403 = Components.Schemas.Error;
+        }
+    }
+    namespace $SearchStreets {
+        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 = /* A search streets payload */ Components.Schemas.SearchStreetsParams;
+        namespace Responses {
+            export type $200 = /* The search providers payload */ Components.Schemas.SearchStreetsResult;
+            export type $400 = Components.Schemas.Error;
+            export type $403 = Components.Schemas.Error;
+        }
+    }
     namespace $ValidateAvailabilityFile {
         export interface HeaderParameters {
             "X-Epilot-Org-ID": Parameters.XEpilotOrgID;
@@ -3042,6 +3228,56 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
+  /**
+   * $searchProviders - searchProviders
+   * 
+   * Returns the list of providers available based on a given location
+   */
+  '$searchProviders'(
+    parameters?: Parameters<Paths.$SearchProviders.PathParameters & Paths.$SearchProviders.HeaderParameters> | null,
+    data?: Paths.$SearchProviders.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$SearchProviders.Responses.$200>
+  /**
+   * $searchStreets - searchStreets
+   * 
+   * 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>
+  /**
+   * $getCredentials - getCredentials
+   * 
+   * Gets the credentials for a given integration / organization
+   */
+  '$getCredentials'(
+    parameters?: Parameters<Paths.$GetCredentials.PathParameters & Paths.$GetCredentials.HeaderParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$GetCredentials.Responses.$200>
+  /**
+   * $saveCredentials - saveCredentials
+   * 
+   * Saves the credentials for a given integration / organization
+   */
+  '$saveCredentials'(
+    parameters?: Parameters<Paths.$SaveCredentials.PathParameters & Paths.$SaveCredentials.HeaderParameters> | null,
+    data?: Paths.$SaveCredentials.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$SaveCredentials.Responses.$204>
+  /**
+   * $deleteCredentials - deleteCredentials
+   * 
+   * Delete the credentials for a given integration / organization
+   */
+  '$deleteCredentials'(
+    parameters?: Parameters<Paths.$DeleteCredentials.PathParameters & Paths.$DeleteCredentials.HeaderParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
   /**
    * $createOpportunity - createOpportunity
    * 
@@ -3142,6 +3378,66 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
   }
+  ['/v1/public/integration/{integrationId}/providers:search']: {
+    /**
+     * $searchProviders - searchProviders
+     * 
+     * Returns the list of providers available based on a given location
+     */
+    'post'(
+      parameters?: Parameters<Paths.$SearchProviders.PathParameters & Paths.$SearchProviders.HeaderParameters> | null,
+      data?: Paths.$SearchProviders.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$SearchProviders.Responses.$200>
+  }
+  ['/v1/public/integration/{integrationId}/streets:search']: {
+    /**
+     * $searchStreets - searchStreets
+     * 
+     * Returns the list of streets available for a given postal_code and city
+     */
+    'post'(
+      parameters?: Parameters<Paths.$SearchStreets.PathParameters & Paths.$SearchStreets.HeaderParameters> | null,
+      data?: Paths.$SearchStreets.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$SearchStreets.Responses.$200>
+  }
+  ['/v1/integration/{integrationId}/credentials']: {
+    /**
+     * $getCredentials - getCredentials
+     * 
+     * Gets the credentials for a given integration / organization
+     */
+    'get'(
+      parameters?: Parameters<Paths.$GetCredentials.PathParameters & Paths.$GetCredentials.HeaderParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$GetCredentials.Responses.$200>
+  }
+  ['/v1/integration/{integrationId}/credentials:save']: {
+    /**
+     * $saveCredentials - saveCredentials
+     * 
+     * Saves the credentials for a given integration / organization
+     */
+    'put'(
+      parameters?: Parameters<Paths.$SaveCredentials.PathParameters & Paths.$SaveCredentials.HeaderParameters> | null,
+      data?: Paths.$SaveCredentials.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$SaveCredentials.Responses.$204>
+  }
+  ['/v1/integration/{integrationId}/credentials:delete']: {
+    /**
+     * $deleteCredentials - deleteCredentials
+     * 
+     * Delete the credentials for a given integration / organization
+     */
+    'delete'(
+      parameters?: Parameters<Paths.$DeleteCredentials.PathParameters & Paths.$DeleteCredentials.HeaderParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
+  }
   ['/v1/public/opportunity']: {
     /**
      * $createOpportunity - createOpportunity

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Pricing API",
-    "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n",
+    "description": "The `pricing-api` hub sets the foundations for the following Pricing APIs:\n\n### Order API\nThis api enables the management of orders in epilot 360, providing features such as:\n - Automatic calculation of totals and price breakdowns for taxes on the Order entity\n - Product and pricing data validation\n\n### Shopping Cart API\nUsed to interact with a cart during a customer's checkout session, providing:\n - An unified data model to model a Shopping Cart\n - Product and pricing data validation\n - Checkout a cart into an order or quote\n\n### Catalog API\nProvides a way to query the entire catalog of products and prices.\n\n### Availability API\nProvides endpoints for querying products availability by a set of predefined dimensions.\n\n### External Integrations API\nProvides endpoints for external integrations (e.g. Enet / GetAG).\n",
     "version": "1.0.0",
     "termsOfService": "https://epilot.cloud/agb",
     "contact": {
@@ -28,6 +28,10 @@
       "name": "Availability API",
       "description": "Provides endpoints for querying products availability by a set of predefined dimensions.\n"
     },
+    {
+      "name": "External Integrations API",
+      "description": "Provides endpoints for external integrations (e.g. Enet / GetAG).\n"
+    },
     {
       "name": "Deprecated Endpoints",
       "description": "Deprecated endpoints.\n"
@@ -804,6 +808,392 @@
         }
       }
     },
+    "/v1/public/integration/{integrationId}/providers:search": {
+      "post": {
+        "description": "Returns the list of providers available based on a given location",
+        "operationId": "$searchProviders",
+        "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": "searchProviders",
+        "tags": [
+          "External Integrations API"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SearchProvidersParams"
+              },
+              "examples": {
+                "Search providers (power)": {
+                  "value": {
+                    "type": "power",
+                    "postal_code": "04109",
+                    "city": "Leipzig",
+                    "street": "Willy-Brandt-Platz"
+                  }
+                },
+                "Search providers (gas)": {
+                  "value": {
+                    "type": "gas",
+                    "postal_code": "57008",
+                    "city": "Cologne",
+                    "street": "Media Park",
+                    "street_number": "8a"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The available providers response payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchProvidersResult"
+                },
+                "examples": {
+                  "Response with available providers": {
+                    "value": [
+                      {
+                        "name": "Provider 1",
+                        "code": "code#1"
+                      },
+                      {
+                        "name": "Provider 2",
+                        "code": "code#2"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "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/public/integration/{integrationId}/streets:search": {
+      "post": {
+        "description": "Returns the list of streets available for a given postal_code and city",
+        "operationId": "$searchStreets",
+        "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": "searchStreets",
+        "tags": [
+          "External Integrations API"
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SearchStreetsParams"
+              },
+              "examples": {
+                "Search streets": {
+                  "value": {
+                    "postal_code": "04109",
+                    "city": "Leipzig"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The available streets response payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchStreetsResult"
+                },
+                "examples": {
+                  "Response with available streets": {
+                    "value": [
+                      {
+                        "name": "Street 1"
+                      },
+                      {
+                        "name": "Street 2"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "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",
+        "operationId": "$getCredentials",
+        "summary": "getCredentials",
+        "tags": [
+          "External Integrations API"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "integrationId",
+            "description": "The integration identifier",
+            "schema": {
+              "$ref": "#/components/schemas/IntegrationId"
+            },
+            "required": true,
+            "example": "getag"
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "description": "The target Organization Id represented by the caller",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "example": 739224
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The credentials response payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/IntegrationCredentialsResult"
+                },
+                "examples": {
+                  "Response when credentials": {
+                    "value": {
+                      "username": "username",
+                      "password": "password"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Credentials not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/integration/{integrationId}/credentials:save": {
+      "put": {
+        "description": "Saves the credentials for a given integration / organization",
+        "operationId": "$saveCredentials",
+        "summary": "saveCredentials",
+        "tags": [
+          "External Integrations API"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "integrationId",
+            "description": "The integration identifier",
+            "schema": {
+              "$ref": "#/components/schemas/IntegrationId"
+            },
+            "required": true,
+            "example": "getag"
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "description": "The target Organization Id represented by the caller",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "example": 739224
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SaveIntegrationCredentialsParams"
+              },
+              "examples": {
+                "Save credentials": {
+                  "value": {
+                    "username": "username",
+                    "password": "password"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "Credentials saved"
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/integration/{integrationId}/credentials:delete": {
+      "delete": {
+        "description": "Delete the credentials for a given integration / organization",
+        "operationId": "$deleteCredentials",
+        "summary": "deleteCredentials",
+        "tags": [
+          "External Integrations API"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "integrationId",
+            "description": "The integration identifier",
+            "schema": {
+              "$ref": "#/components/schemas/IntegrationId"
+            },
+            "required": true,
+            "example": "getag"
+          },
+          {
+            "in": "header",
+            "name": "X-Epilot-Org-ID",
+            "description": "The target Organization Id represented by the caller",
+            "schema": {
+              "type": "string"
+            },
+            "required": true,
+            "example": 739224
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Credentials deleted"
+          },
+          "400": {
+            "description": "Invalid payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/public/opportunity": {
       "post": {
         "deprecated": true,
@@ -905,6 +1295,13 @@
       }
     },
     "schemas": {
+      "IntegrationId": {
+        "type": "string",
+        "enum": [
+          "enet",
+          "getag"
+        ]
+      },
       "Error": {
         "required": [
           "message"
@@ -1965,6 +2362,62 @@
           ]
         }
       },
+      "SearchProvidersParams": {
+        "description": "A search providers payload",
+        "type": "object",
+        "properties": {
+          "type": {
+            "description": "The provider type (power or gas)",
+            "type": "string",
+            "enum": [
+              "power",
+              "gas"
+            ]
+          },
+          "postal_code": {
+            "description": "The postal code to search for providers",
+            "type": "string"
+          },
+          "city": {
+            "description": "The city to search for providers",
+            "type": "string",
+            "nullable": true
+          },
+          "street": {
+            "description": "The street to search for providers",
+            "type": "string",
+            "nullable": true
+          },
+          "street_number": {
+            "description": "The street number to search for providers",
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "required": [
+          "type",
+          "postal_code"
+        ]
+      },
+      "SearchStreetsParams": {
+        "description": "A search streets payload",
+        "type": "object",
+        "properties": {
+          "postal_code": {
+            "description": "The postal code to search for providers",
+            "type": "string"
+          },
+          "city": {
+            "description": "The city to search for providers",
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "required": [
+          "city",
+          "postal_code"
+        ]
+      },
       "AvailabilityCheckParams": {
         "description": "Availability check request payload",
         "type": "object",
@@ -2060,6 +2513,89 @@
           "msg"
         ]
       },
+      "IntegrationCredentialsResult": {
+        "description": "The credentials response payload",
+        "type": "object",
+        "properties": {
+          "schema": {
+            "$ref": "#/components/schemas/BasicAuthCredentials"
+          }
+        }
+      },
+      "SaveIntegrationCredentialsParams": {
+        "description": "The credentials request payload",
+        "type": "object",
+        "properties": {
+          "schema": {
+            "$ref": "#/components/schemas/BasicAuthCredentials"
+          }
+        }
+      },
+      "BasicAuthCredentials": {
+        "description": "The basic auth credentials",
+        "type": "object",
+        "properties": {
+          "username": {
+            "description": "The username",
+            "type": "string",
+            "example": "username"
+          },
+          "password": {
+            "description": "The password",
+            "type": "string",
+            "example": "123456"
+          }
+        },
+        "required": [
+          "username",
+          "password"
+        ]
+      },
+      "SearchStreetsResult": {
+        "description": "The search providers payload",
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/Street"
+        }
+      },
+      "SearchProvidersResult": {
+        "description": "The search providers payload",
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/Provider"
+        }
+      },
+      "Provider": {
+        "description": "The provider entity",
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "The provider name",
+            "type": "string"
+          },
+          "code": {
+            "description": "The provider code",
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "code"
+        ]
+      },
+      "Street": {
+        "description": "The street entity",
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "The street name",
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      },
       "ValidateAvailabilityFileResult": {
         "description": "The availability map file result payload",
         "type": "object",
@@ -2981,7 +3517,7 @@
               },
               "recurrences": {
                 "type": "array",
-                "description": "The aggregated price items recurrences.",
+                "description": "The aggregated price items tax amount per rate.",
                 "items": {
                   "oneOf": [
                     {

package/package.json

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