@epilot/pricing-client 3.52.0 → 3.53.0

package/dist/openapi.d.ts

@@ -153,7 +153,7 @@ declare namespace Components {
             /**
              * The postal code for the address.
              */
-            postal_code?: string;
+            postal_code: string;
             /**
              * The name of the city, district, village, or town.
              */
@@ -4587,6 +4587,18 @@ declare namespace Components {
             origin: "journey";
             context: JourneyContext;
         }
+        /**
+         * The request payload for the external catalog service with a portal context.
+         */
+        export interface ExternalCatalogPortalRequest {
+            /**
+             * The origin of the request.
+             * example:
+             * portal
+             */
+            origin: "portal";
+            context: PortalContext;
+        }
         /**
          * The request payload for the external catalog service.
          * example:
@@ -4692,7 +4704,7 @@ declare namespace Components {
          *   }
          * }
          */
-        /* The request payload for the external catalog service with a journey context. */ ExternalCatalogJourneyRequest | /* The request payload for the external catalog service with a custom context. E.g. for requests from the Portal. */ ExternalCatalogCustomRequest);
+        /* The request payload for the external catalog service with a journey context. */ ExternalCatalogJourneyRequest | /* The request payload for the external catalog service with a portal context. */ ExternalCatalogPortalRequest | /* The request payload for the external catalog service with a custom context. E.g. for requests from the Portal. */ ExternalCatalogCustomRequest);
         /**
          * example:
          * {
@@ -6389,6 +6401,10 @@ declare namespace Components {
             prices?: {
                 $relation?: EntityRelation[];
             };
+            /**
+             * The coupons referenced from within `line_items`
+             */
+            coupons?: any[];
             /**
              * Total of all items before (discounts or) taxes are applied.
              */
@@ -6526,6 +6542,297 @@ declare namespace Components {
                 [name: string]: any;
             };
         }
+        export interface PortalContext {
+            /**
+             * The contract information.
+             */
+            contract: {
+                /**
+                 * The unique identifier of the contract.
+                 */
+                _id?: string;
+                /**
+                 * Contract Name
+                 */
+                contract_name?: string;
+                /**
+                 * Contract Number
+                 */
+                contract_number?: string;
+                /**
+                 * Assignee user ID
+                 */
+                assignee?: string;
+                /**
+                 * Contract status
+                 */
+                status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
+                /**
+                 * Description of the contract
+                 */
+                description?: string;
+                /**
+                 * Billing Account relation ID
+                 */
+                billing_account?: string;
+                /**
+                 * Account Number
+                 */
+                account_number?: string;
+                /**
+                 * Branch/commodity type
+                 */
+                branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
+                /**
+                 * Move In Date
+                 */
+                move_in_date?: string; // date
+                /**
+                 * Move Out Date
+                 */
+                move_out_date?: string; // date
+                /**
+                 * Billing Address
+                 */
+                billing_address?: {
+                    [key: string]: any;
+                };
+                /**
+                 * Delivery Address
+                 */
+                delivery_address?: {
+                    [key: string]: any;
+                };
+                /**
+                 * Additional Addresses
+                 */
+                additional_addresses?: {
+                    [key: string]: any;
+                }[];
+                /**
+                 * Date of Termination
+                 */
+                termination_date?: string; // date
+                /**
+                 * Reason For Termination
+                 */
+                termination_reason?: string;
+                /**
+                 * Start Date
+                 */
+                start_date?: string; // date
+                /**
+                 * End Date
+                 */
+                end_date?: string; // date
+                /**
+                 * Customer relation (contact or account)
+                 */
+                customer?: string[];
+                /**
+                 * Order relation ID
+                 */
+                order?: string;
+                /**
+                 * Contract type
+                 */
+                type?: "one_time" | "recurring";
+                /**
+                 * Billing Period
+                 */
+                billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
+                /**
+                 * Billing Duration amount
+                 */
+                billing_duration_amount?: number;
+                /**
+                 * Billing Duration Unit
+                 */
+                billing_duration_unit?: "weeks" | "months" | "years";
+                /**
+                 * Notice Time amount
+                 */
+                notice_time_amount?: number;
+                /**
+                 * Notice Time Unit
+                 */
+                notice_time_unit?: "weeks" | "months" | "years";
+                /**
+                 * Termination Time amount
+                 */
+                termination_time_amount?: number;
+                /**
+                 * Termination Time Unit
+                 */
+                termination_time_unit?: "weeks" | "months" | "years";
+                /**
+                 * Renewal Duration amount
+                 */
+                renewal_duration_amount?: number;
+                /**
+                 * Renewal Duration Unit
+                 */
+                renewal_duration_unit?: "weeks" | "months" | "years";
+                /**
+                 * Billing Due Day
+                 */
+                billing_due_day?: number;
+                /**
+                 * Installment Amount
+                 */
+                installment_amount?: {
+                    value?: number;
+                    currency?: string;
+                };
+                /**
+                 * Balance
+                 */
+                balance?: {
+                    value?: number;
+                    currency?: string;
+                };
+                /**
+                 * Meters relation
+                 */
+                meters?: string[];
+                /**
+                 * Payment Details relation ID
+                 */
+                payment?: string;
+                /**
+                 * Last Sync At
+                 */
+                last_sync_at?: string; // date
+                /**
+                 * External ID
+                 */
+                external_id?: string;
+            };
+            /**
+             * The contact information.
+             */
+            contact: {
+                /**
+                 * The unique identifier of the contact.
+                 */
+                _id?: string;
+                /**
+                 * Salutation
+                 */
+                salutation?: "Mr." | "Ms. / Mrs." | "Company" | "Contact Person" | "Company/Contact Person" | "Spouse" | "Family" | "Ownership" | "Assembly" | "Other";
+                /**
+                 * Title
+                 */
+                title?: "Dr." | "Prof." | "Prof. Dr.";
+                /**
+                 * First Name
+                 */
+                first_name?: string;
+                /**
+                 * Last Name
+                 */
+                last_name?: string;
+                /**
+                 * Customer Number
+                 */
+                customer_number?: string;
+                /**
+                 * Date of Birth
+                 */
+                birthdate?: string; // date
+                /**
+                 * Email addresses
+                 */
+                email?: {
+                    email?: string; // email
+                    _primary?: boolean;
+                }[];
+                /**
+                 * Phone numbers
+                 */
+                phone?: {
+                    phone?: string;
+                    _primary?: boolean;
+                }[];
+                /**
+                 * Standard communication method
+                 */
+                communication_preference?: "postal" | "portal";
+                /**
+                 * Addresses
+                 */
+                address?: {
+                    _primary?: boolean;
+                    postal_code?: string;
+                    city?: string;
+                    street?: string;
+                    street_number?: string;
+                    country?: string;
+                }[];
+                /**
+                 * Payment methods
+                 */
+                payment?: {
+                    _primary?: boolean;
+                }[];
+                /**
+                 * Account relations
+                 */
+                account?: string[];
+                /**
+                 * Marketing Permission (deprecated)
+                 */
+                marketing_permission?: boolean;
+                /**
+                 * Contact Owner user ID
+                 */
+                contact_owner?: string;
+                /**
+                 * Email Marketing consent
+                 */
+                consent_email_marketing?: {
+                    [key: string]: any;
+                };
+                /**
+                 * SMS Marketing consent
+                 */
+                consent_sms_marketing?: {
+                    [key: string]: any;
+                };
+                /**
+                 * Direct Phone Marketing consent
+                 */
+                consent_phone_call?: {
+                    [key: string]: any;
+                };
+                /**
+                 * Print Marketing consent
+                 */
+                consent_print_marketing?: {
+                    [key: string]: any;
+                };
+                /**
+                 * Portal Users relation
+                 */
+                portal_users?: string[];
+                /**
+                 * Opportunities relation
+                 */
+                opportunities?: string[];
+                /**
+                 * Orders relation
+                 */
+                orders?: string[];
+                /**
+                 * Contracts relation
+                 */
+                contracts?: string[];
+                /**
+                 * External ID
+                 */
+                external_id?: string;
+            };
+        }
         /**
          * The meter type for power
          */
@@ -9628,6 +9935,7 @@ declare namespace Paths {
         namespace Responses {
             export type $200 = Components.Schemas.AverageMarketPriceResult;
             export type $400 = Components.Schemas.Error;
+            export type $404 = Components.Schemas.Error;
         }
     }
     namespace $CalculatePricingDetails {
@@ -9815,6 +10123,7 @@ declare namespace Paths {
         namespace Responses {
             export type $200 = Components.Schemas.HistoricMarketPricesResult;
             export type $400 = Components.Schemas.Error;
+            export type $404 = Components.Schemas.Error;
         }
     }
     namespace $PrivateSearchCatalog {
@@ -11746,6 +12055,7 @@ export type ExternalCatalogConfigurationRequest = Components.Schemas.ExternalCat
 export type ExternalCatalogCustomRequest = Components.Schemas.ExternalCatalogCustomRequest;
 export type ExternalCatalogItem = Components.Schemas.ExternalCatalogItem;
 export type ExternalCatalogJourneyRequest = Components.Schemas.ExternalCatalogJourneyRequest;
+export type ExternalCatalogPortalRequest = Components.Schemas.ExternalCatalogPortalRequest;
 export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest;
 export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping;
 export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings;
@@ -11774,6 +12084,7 @@ export type OrderRelation = Components.Schemas.OrderRelation;
 export type OrderSource = Components.Schemas.OrderSource;
 export type OrderStatus = Components.Schemas.OrderStatus;
 export type PaymentMethod = Components.Schemas.PaymentMethod;
+export type PortalContext = Components.Schemas.PortalContext;
 export type PowerMeterType = Components.Schemas.PowerMeterType;
 export type Price = Components.Schemas.Price;
 export type PriceAmounts = Components.Schemas.PriceAmounts;

package/dist/openapi.json

@@ -94,6 +94,7 @@
         "Spot Market API",
         "Availability API",
         "External Integrations API",
+        "External Catalog API",
         "Product Recommendations API",
         "Promo Codes API"
       ]
@@ -129,8 +130,7 @@
   "servers": [
     {
       "url": "https://pricing-api.sls.epilot.io"
-    },
-    null
+    }
   ],
   "paths": {
     "/v1/pricing:compute": {
@@ -1575,6 +1575,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "No prices for date range found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
           }
         }
       }
@@ -1666,6 +1676,16 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "No prices for date range found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
           }
         }
       }
@@ -4609,6 +4629,18 @@
               }
             }
           },
+          "coupons": {
+            "type": "array",
+            "description": "The coupons referenced from within `line_items`",
+            "properties": {
+              "$relation": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/EntityRelation"
+                }
+              }
+            }
+          },
           "amount_subtotal": {
             "readOnly": true,
             "type": "integer",
@@ -7747,7 +7779,10 @@
             "type": "string",
             "description": "The name of the country."
           }
-        }
+        },
+        "required": [
+          "postal_code"
+        ]
       },
       "AvailabilityFilters": {
         "description": "Availability filters dimensions",
@@ -8776,6 +8811,9 @@
               {
                 "$ref": "#/components/schemas/ExternalCatalogJourneyRequest"
               },
+              {
+                "$ref": "#/components/schemas/ExternalCatalogPortalRequest"
+              },
               {
                 "$ref": "#/components/schemas/ExternalCatalogCustomRequest"
               }
@@ -8786,6 +8824,7 @@
           "propertyName": "origin",
           "mapping": {
             "journey": "#/components/schemas/ExternalCatalogJourneyRequest",
+            "portal": "#/components/schemas/ExternalCatalogPortalRequest",
             "custom": "#/components/schemas/ExternalCatalogCustomRequest"
           }
         },
@@ -8886,6 +8925,27 @@
           "context"
         ]
       },
+      "ExternalCatalogPortalRequest": {
+        "type": "object",
+        "description": "The request payload for the external catalog service with a portal context.",
+        "properties": {
+          "origin": {
+            "type": "string",
+            "description": "The origin of the request.",
+            "enum": [
+              "portal"
+            ],
+            "example": "portal"
+          },
+          "context": {
+            "$ref": "#/components/schemas/PortalContext"
+          }
+        },
+        "required": [
+          "origin",
+          "context"
+        ]
+      },
       "ExternalCatalogCustomRequest": {
         "type": "object",
         "description": "The request payload for the external catalog service with a custom context. E.g. for requests from the Portal.",
@@ -9002,6 +9062,451 @@
           "steps_data"
         ]
       },
+      "PortalContext": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "contract": {
+            "type": "object",
+            "description": "The contract information.",
+            "properties": {
+              "_id": {
+                "type": "string",
+                "description": "The unique identifier of the contract."
+              },
+              "contract_name": {
+                "type": "string",
+                "description": "Contract Name"
+              },
+              "contract_number": {
+                "type": "string",
+                "description": "Contract Number"
+              },
+              "assignee": {
+                "type": "string",
+                "description": "Assignee user ID"
+              },
+              "status": {
+                "type": "string",
+                "description": "Contract status",
+                "enum": [
+                  "draft",
+                  "in_approval_process",
+                  "approved",
+                  "active",
+                  "deactivated",
+                  "revoked",
+                  "terminated",
+                  "expired"
+                ]
+              },
+              "description": {
+                "type": "string",
+                "description": "Description of the contract"
+              },
+              "billing_account": {
+                "type": "string",
+                "description": "Billing Account relation ID"
+              },
+              "account_number": {
+                "type": "string",
+                "description": "Account Number"
+              },
+              "branch": {
+                "type": "string",
+                "description": "Branch/commodity type",
+                "enum": [
+                  "power",
+                  "gas",
+                  "water",
+                  "waste_water",
+                  "district_heating"
+                ]
+              },
+              "move_in_date": {
+                "type": "string",
+                "format": "date",
+                "description": "Move In Date"
+              },
+              "move_out_date": {
+                "type": "string",
+                "format": "date",
+                "description": "Move Out Date"
+              },
+              "billing_address": {
+                "type": "object",
+                "description": "Billing Address"
+              },
+              "delivery_address": {
+                "type": "object",
+                "description": "Delivery Address"
+              },
+              "additional_addresses": {
+                "type": "array",
+                "description": "Additional Addresses",
+                "items": {
+                  "type": "object"
+                }
+              },
+              "termination_date": {
+                "type": "string",
+                "format": "date",
+                "description": "Date of Termination"
+              },
+              "termination_reason": {
+                "type": "string",
+                "description": "Reason For Termination"
+              },
+              "start_date": {
+                "type": "string",
+                "format": "date",
+                "description": "Start Date"
+              },
+              "end_date": {
+                "type": "string",
+                "format": "date",
+                "description": "End Date"
+              },
+              "customer": {
+                "type": "array",
+                "description": "Customer relation (contact or account)",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "order": {
+                "type": "string",
+                "description": "Order relation ID"
+              },
+              "type": {
+                "type": "string",
+                "description": "Contract type",
+                "enum": [
+                  "one_time",
+                  "recurring"
+                ]
+              },
+              "billing_period": {
+                "type": "string",
+                "description": "Billing Period",
+                "enum": [
+                  "weekly",
+                  "monthly",
+                  "every_quarter",
+                  "every_6_months",
+                  "yearly"
+                ]
+              },
+              "billing_duration_amount": {
+                "type": "number",
+                "description": "Billing Duration amount",
+                "minimum": 0
+              },
+              "billing_duration_unit": {
+                "type": "string",
+                "description": "Billing Duration Unit",
+                "enum": [
+                  "weeks",
+                  "months",
+                  "years"
+                ]
+              },
+              "notice_time_amount": {
+                "type": "number",
+                "description": "Notice Time amount",
+                "minimum": 0
+              },
+              "notice_time_unit": {
+                "type": "string",
+                "description": "Notice Time Unit",
+                "enum": [
+                  "weeks",
+                  "months",
+                  "years"
+                ]
+              },
+              "termination_time_amount": {
+                "type": "number",
+                "description": "Termination Time amount",
+                "minimum": 0
+              },
+              "termination_time_unit": {
+                "type": "string",
+                "description": "Termination Time Unit",
+                "enum": [
+                  "weeks",
+                  "months",
+                  "years"
+                ]
+              },
+              "renewal_duration_amount": {
+                "type": "number",
+                "description": "Renewal Duration amount",
+                "minimum": 0
+              },
+              "renewal_duration_unit": {
+                "type": "string",
+                "description": "Renewal Duration Unit",
+                "enum": [
+                  "weeks",
+                  "months",
+                  "years"
+                ]
+              },
+              "billing_due_day": {
+                "type": "number",
+                "description": "Billing Due Day"
+              },
+              "installment_amount": {
+                "type": "object",
+                "description": "Installment Amount",
+                "properties": {
+                  "value": {
+                    "type": "number"
+                  },
+                  "currency": {
+                    "type": "string",
+                    "default": "EUR"
+                  }
+                }
+              },
+              "balance": {
+                "type": "object",
+                "description": "Balance",
+                "properties": {
+                  "value": {
+                    "type": "number"
+                  },
+                  "currency": {
+                    "type": "string",
+                    "default": "EUR"
+                  }
+                }
+              },
+              "meters": {
+                "type": "array",
+                "description": "Meters relation",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "payment": {
+                "type": "string",
+                "description": "Payment Details relation ID"
+              },
+              "last_sync_at": {
+                "type": "string",
+                "format": "date",
+                "description": "Last Sync At"
+              },
+              "external_id": {
+                "type": "string",
+                "description": "External ID",
+                "readOnly": true
+              }
+            }
+          },
+          "contact": {
+            "type": "object",
+            "description": "The contact information.",
+            "properties": {
+              "_id": {
+                "type": "string",
+                "description": "The unique identifier of the contact."
+              },
+              "salutation": {
+                "type": "string",
+                "description": "Salutation",
+                "enum": [
+                  "Mr.",
+                  "Ms. / Mrs.",
+                  "Company",
+                  "Contact Person",
+                  "Company/Contact Person",
+                  "Spouse",
+                  "Family",
+                  "Ownership",
+                  "Assembly",
+                  "Other"
+                ]
+              },
+              "title": {
+                "type": "string",
+                "description": "Title",
+                "enum": [
+                  "Dr.",
+                  "Prof.",
+                  "Prof. Dr."
+                ]
+              },
+              "first_name": {
+                "type": "string",
+                "description": "First Name"
+              },
+              "last_name": {
+                "type": "string",
+                "description": "Last Name"
+              },
+              "customer_number": {
+                "type": "string",
+                "description": "Customer Number"
+              },
+              "birthdate": {
+                "type": "string",
+                "format": "date",
+                "description": "Date of Birth"
+              },
+              "email": {
+                "type": "array",
+                "description": "Email addresses",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "email": {
+                      "type": "string",
+                      "format": "email"
+                    },
+                    "_primary": {
+                      "type": "boolean"
+                    }
+                  }
+                }
+              },
+              "phone": {
+                "type": "array",
+                "description": "Phone numbers",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "phone": {
+                      "type": "string"
+                    },
+                    "_primary": {
+                      "type": "boolean"
+                    }
+                  }
+                }
+              },
+              "communication_preference": {
+                "type": "string",
+                "description": "Standard communication method",
+                "enum": [
+                  "postal",
+                  "portal"
+                ]
+              },
+              "address": {
+                "type": "array",
+                "description": "Addresses",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "_primary": {
+                      "type": "boolean"
+                    },
+                    "postal_code": {
+                      "type": "string"
+                    },
+                    "city": {
+                      "type": "string"
+                    },
+                    "street": {
+                      "type": "string"
+                    },
+                    "street_number": {
+                      "type": "string"
+                    },
+                    "country": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "payment": {
+                "type": "array",
+                "description": "Payment methods",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "_primary": {
+                      "type": "boolean"
+                    }
+                  }
+                }
+              },
+              "account": {
+                "type": "array",
+                "description": "Account relations",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "marketing_permission": {
+                "type": "boolean",
+                "description": "Marketing Permission (deprecated)",
+                "deprecated": true
+              },
+              "contact_owner": {
+                "type": "string",
+                "description": "Contact Owner user ID"
+              },
+              "consent_email_marketing": {
+                "type": "object",
+                "description": "Email Marketing consent"
+              },
+              "consent_sms_marketing": {
+                "type": "object",
+                "description": "SMS Marketing consent"
+              },
+              "consent_phone_call": {
+                "type": "object",
+                "description": "Direct Phone Marketing consent"
+              },
+              "consent_print_marketing": {
+                "type": "object",
+                "description": "Print Marketing consent"
+              },
+              "portal_users": {
+                "type": "array",
+                "description": "Portal Users relation",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "opportunities": {
+                "type": "array",
+                "description": "Opportunities relation",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "orders": {
+                "type": "array",
+                "description": "Orders relation",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "contracts": {
+                "type": "array",
+                "description": "Contracts relation",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "external_id": {
+                "type": "string",
+                "description": "External ID",
+                "readOnly": true
+              }
+            }
+          }
+        },
+        "required": [
+          "contract",
+          "contact"
+        ]
+      },
       "SearchExternalCatalogResult": {
         "type": "object",
         "properties": {

package/package.json

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