diff --git a/clients/pricing-client/package.json b/clients/pricing-client/package.json index 2616d537..bf0c7b66 100644 --- a/clients/pricing-client/package.json +++ b/clients/pricing-client/package.json @@ -1,6 +1,6 @@ { "name": "@epilot/pricing-client", - "version": "3.53.8", + "version": "3.54.0", "description": "Client for epilot Pricing APIs", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/clients/pricing-client/src/openapi.d.ts b/clients/pricing-client/src/openapi.d.ts index 31189fef..5deadeac 100644 --- a/clients/pricing-client/src/openapi.d.ts +++ b/clients/pricing-client/src/openapi.d.ts @@ -8,6 +8,48 @@ import type { declare namespace Components { namespace Schemas { + /** + * Additional data included in the provider entity + */ + export interface AdditionalProviderData { + gridOperators: { + /** + * The name of the participant + */ + name: string; + /** + * The BDEW/DVGW code number of the participant + */ + codeNumber: string; + /** + * The date from which this data is valid from + */ + validFrom?: string; // date + /** + * The date until which this data is valid to + */ + validUntil?: string; // date + }[]; + defaultSuppliers: { + /** + * The name of the participant + */ + name: string; + /** + * The BDEW/DVGW code number of the participant + */ + codeNumber: string; + /** + * The date from which this data is valid from + */ + validFrom?: string; // date + /** + * The date until which this data is valid to + */ + validUntil?: string; // date + }[]; + marketAreaDetails: /* Market area details for gas */ GasMarketAreaDetails | /* Market area details for power */ PowerMarketAreaDetails; + } export interface Address { [name: string]: any; /** @@ -1451,6 +1493,7 @@ declare namespace Components { */ ExternalFeeMappings; external_fees_metadata?: ExternalFeeMetadata; + external_location_metadata?: /* The provider entity */ ExternalLocationMetadata; external_price_metadata?: ExternalPriceMetadata; _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails; /** @@ -1559,9 +1602,13 @@ declare namespace Components { }; } /** - * An amount associated with a specific cashback period. + * A detail associated with a specific cashback. */ export interface CashbackAmount { + /** + * The name of the cashback. + */ + cashback_name?: string; cashback_period: /* The cashback period, for now it's limited to either 0 months or 12 months */ CashbackPeriod; /** * The sum of all cashbacks for a specific cashback period @@ -3692,6 +3739,7 @@ declare namespace Components { */ ExternalFeeMappings; external_fees_metadata?: ExternalFeeMetadata; + external_location_metadata?: /* The provider entity */ ExternalLocationMetadata; external_price_metadata?: ExternalPriceMetadata; _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails; /** @@ -4841,6 +4889,28 @@ declare namespace Components { [name: string]: any; }; } + /** + * The provider entity + */ + export interface ExternalLocationMetadata { + /** + * The provider name + */ + name: string; + /** + * The provider code + */ + code: string; + /** + * The type of product + */ + type: "gas" | "power"; + additionalData: /* Additional data included in the provider entity */ AdditionalProviderData; + _meta?: /* Signature meta data payload */ SignatureMeta; + inputs?: { + [name: string]: any; + }; + } export interface ExternalPriceMetadata { market: /* The market for a spot market price. */ SpotMarketType; bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone; @@ -4873,6 +4943,23 @@ declare namespace Components { * The concession type for gas */ export type GasConcessionType = "standard" | "special"; + /** + * Market area details for gas + */ + export interface GasMarketAreaDetails { + /** + * The type of gas used + */ + gasType?: "L-Gas" | "H-Gas"; + /** + * The name of the market area + */ + marketArea?: string; + /** + * The vritual trading point identifier + */ + virtualTradingPoint?: string; + } /** * A market price at a given point in time. */ @@ -5217,6 +5304,27 @@ declare namespace Components { }; }[]; } + /** + * Market participant data + */ + export interface MarketParticipant { + /** + * The name of the participant + */ + name: string; + /** + * The BDEW/DVGW code number of the participant + */ + codeNumber: string; + /** + * The date from which this data is valid from + */ + validFrom?: string; // date + /** + * The date until which this data is valid to + */ + validUntil?: string; // date + } /** * Describes how to compute the markup per period. Either `per_unit`, `tiered_volume` or `tiered_flatfee`. * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity @@ -6575,291 +6683,18 @@ declare namespace Components { }; } export interface PortalContext { + [name: string]: any; /** * 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 - */ - billing_account?: { - [key: string]: any; - }; - /** - * Account Number - */ - account_number?: string; - /** - * Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value) - */ - branch?: string; - /** - * 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?: { - [key: string]: any; - }; - /** - * 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?: number; - /** - * Balance - */ - balance?: number; - /** - * Meters relation - */ - meters?: string[]; - /** - * Payment Details relation - */ - payment?: { - [key: string]: any; - }; - /** - * Last Sync At - */ - last_sync_at?: string; // date - /** - * External ID - */ - external_id?: string; + [name: string]: any; }; /** * 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; + [name: string]: any; }; /** * Address to use for product availability checks. Include when the catalog should filter products by serviceable area (e.g. postal code coverage). @@ -6910,6 +6745,19 @@ declare namespace Components { journey_target_block?: string; }[]; } + /** + * Market area details for power + */ + export interface PowerMarketAreaDetails { + /** + * The EIC of the control zone + */ + controlZone?: string; + /** + * The EIC of the balancing zone + */ + balancingZone?: string; + } /** * The meter type for power */ @@ -8107,6 +7955,7 @@ declare namespace Components { */ ExternalFeeMappings; external_fees_metadata?: ExternalFeeMetadata; + external_location_metadata?: /* The provider entity */ ExternalLocationMetadata; external_price_metadata?: ExternalPriceMetadata; _immutable_pricing_details?: /* The result from the calculation of a set of price items. */ PricingDetails; /** @@ -9405,6 +9254,12 @@ declare namespace Components { * The provider code */ code: string; + /** + * The type of product + */ + type: "gas" | "power"; + additionalData: /* Additional data included in the provider entity */ AdditionalProviderData; + _meta?: /* Signature meta data payload */ SignatureMeta; } /** * An amount associated with a specific recurrence. @@ -9937,9 +9792,9 @@ declare namespace Components { */ recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[]; /** - * The list of cashback sums for each cashback period. + * The list of cashbacks applied. */ - cashbacks?: (/* An amount associated with a specific cashback period. */ CashbackAmount)[]; + cashbacks?: (/* A detail associated with a specific cashback. */ CashbackAmount)[]; /** * The aggregated price items recurrences by tax rate */ @@ -12113,6 +11968,7 @@ export interface PathsDictionary { export type Client = OpenAPIClient +export type AdditionalProviderData = Components.Schemas.AdditionalProviderData; export type Address = Components.Schemas.Address; export type Amounts = Components.Schemas.Amounts; export type AvailabilityCheckParams = Components.Schemas.AvailabilityCheckParams; @@ -12173,9 +12029,11 @@ export type ExternalCatalogRequest = Components.Schemas.ExternalCatalogRequest; export type ExternalFeeMapping = Components.Schemas.ExternalFeeMapping; export type ExternalFeeMappings = Components.Schemas.ExternalFeeMappings; export type ExternalFeeMetadata = Components.Schemas.ExternalFeeMetadata; +export type ExternalLocationMetadata = Components.Schemas.ExternalLocationMetadata; export type ExternalPriceMetadata = Components.Schemas.ExternalPriceMetadata; export type File = Components.Schemas.File; export type GasConcessionType = Components.Schemas.GasConcessionType; +export type GasMarketAreaDetails = Components.Schemas.GasMarketAreaDetails; export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord; export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult; export type HydratedCompositePrice = Components.Schemas.HydratedCompositePrice; @@ -12183,6 +12041,7 @@ export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCrede export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult; export type IntegrationId = Components.Schemas.IntegrationId; export type JourneyContext = Components.Schemas.JourneyContext; +export type MarketParticipant = Components.Schemas.MarketParticipant; export type MarkupPricingModel = Components.Schemas.MarkupPricingModel; export type MetaData = Components.Schemas.MetaData; export type NonHydratedCompositePrice = Components.Schemas.NonHydratedCompositePrice; @@ -12198,6 +12057,7 @@ 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 PowerMarketAreaDetails = Components.Schemas.PowerMarketAreaDetails; export type PowerMeterType = Components.Schemas.PowerMeterType; export type Price = Components.Schemas.Price; export type PriceAmounts = Components.Schemas.PriceAmounts; diff --git a/clients/pricing-client/src/openapi.json b/clients/pricing-client/src/openapi.json index 6fa9d56a..5354c0e6 100644 --- a/clients/pricing-client/src/openapi.json +++ b/clients/pricing-client/src/openapi.json @@ -5432,6 +5432,20 @@ } } }, + "ExternalLocationMetadata": { + "allOf": [ + { + "$ref": "#/components/schemas/Provider" + } + ], + "type": "object", + "properties": { + "inputs": { + "type": "object", + "additionalProperties": true + } + } + }, "ExternalPriceMetadata": { "allOf": [ { @@ -6314,13 +6328,140 @@ "code": { "description": "The provider code", "type": "string" + }, + "type": { + "description": "The type of product", + "type": "string", + "enum": [ + "gas", + "power" + ] + }, + "additionalData": { + "$ref": "#/components/schemas/AdditionalProviderData" + }, + "_meta": { + "$ref": "#/components/schemas/SignatureMeta" } }, "required": [ "name", - "code" + "code", + "type", + "additionalData" + ] + }, + "AdditionalProviderData": { + "description": "Additional data included in the provider entity", + "type": "object", + "properties": { + "gridOperators": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/MarketParticipant" + }, + { + "description": "The grid operator" + } + ] + } + }, + "defaultSuppliers": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/MarketParticipant" + }, + { + "description": "The default supplier" + } + ] + } + }, + "marketAreaDetails": { + "oneOf": [ + { + "$ref": "#/components/schemas/GasMarketAreaDetails" + }, + { + "$ref": "#/components/schemas/PowerMarketAreaDetails" + } + ] + } + }, + "required": [ + "gridOperators", + "defaultSuppliers", + "marketAreaDetails" ] }, + "MarketParticipant": { + "description": "Market participant data", + "type": "object", + "properties": { + "name": { + "description": "The name of the participant", + "type": "string" + }, + "codeNumber": { + "description": "The BDEW/DVGW code number of the participant", + "type": "string" + }, + "validFrom": { + "description": "The date from which this data is valid from", + "type": "string", + "format": "date" + }, + "validUntil": { + "description": "The date until which this data is valid to", + "type": "string", + "format": "date" + } + }, + "required": [ + "name", + "codeNumber" + ] + }, + "GasMarketAreaDetails": { + "description": "Market area details for gas", + "type": "object", + "properties": { + "gasType": { + "description": "The type of gas used", + "type": "string", + "enum": [ + "L-Gas", + "H-Gas" + ] + }, + "marketArea": { + "description": "The name of the market area", + "type": "string" + }, + "virtualTradingPoint": { + "description": "The vritual trading point identifier", + "type": "string" + } + } + }, + "PowerMarketAreaDetails": { + "description": "Market area details for power", + "type": "object", + "properties": { + "controlZone": { + "description": "The EIC of the control zone", + "type": "string" + }, + "balancingZone": { + "description": "The EIC of the balancing zone", + "type": "string" + } + } + }, "Street": { "description": "The street entity", "type": "object", @@ -6581,6 +6722,9 @@ "external_fees_metadata": { "$ref": "#/components/schemas/ExternalFeeMetadata" }, + "external_location_metadata": { + "$ref": "#/components/schemas/ExternalLocationMetadata" + }, "external_price_metadata": { "$ref": "#/components/schemas/ExternalPriceMetadata" }, @@ -7679,7 +7823,7 @@ }, "cashbacks": { "type": "array", - "description": "The list of cashback sums for each cashback period.", + "description": "The list of cashbacks applied.", "items": { "oneOf": [ { @@ -9107,416 +9251,17 @@ }, "PortalContext": { "type": "object", - "additionalProperties": false, + "additionalProperties": true, "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": "object", - "description": "Billing Account relation" - }, - "account_number": { - "type": "string", - "description": "Account Number" - }, - "branch": { - "type": "string", - "description": "Branch/commodity type (e.g. power, gas, water, waste_water, district_heating, or any custom value)" - }, - "move_in_date": { - "type": "string", - "format": "date", - "description": "Move In Date" - }, - "move_out_date": { - "type": "string", - "format": "date", - "description": "Move Out Date" - }, - "billing_address": { - "description": "Billing Address", - "type": "object" - }, - "delivery_address": { - "description": "Delivery Address", - "type": "array", - "items": { - "type": "object" - } - }, - "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": "object", - "description": "Customer relation (contact or account)" - }, - "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": "number" - }, - "balance": { - "type": "number", - "description": "Balance" - }, - "meters": { - "type": "array", - "description": "Meters relation", - "items": { - "type": "string" - } - }, - "payment": { - "type": "object", - "description": "Payment Details relation" - }, - "last_sync_at": { - "type": "string", - "format": "date", - "description": "Last Sync At" - }, - "external_id": { - "type": "string", - "description": "External ID", - "readOnly": true - } - } + "additionalProperties": 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 - } - } + "additionalProperties": true }, "availability_address": { "type": "object",