@epilot/sdk 2.15.8 → 2.15.9

package/dist/{pricing.d-BgjfwicJ.d.ts → pricing.d-C2Jgx_-V.d.ts}

@@ -4111,6 +4111,84 @@ declare namespace Components {
         export interface ComputedPriceComponents {
             [name: string]: /* The computed price */ ComputedBasePrice;
         }
+        /**
+         * An error from a conditional-pricing operation, carrying a machine-readable `code`
+         * from the conditional-pricing vocabulary plus any structured data about the failure,
+         * so a client can branch on the kind of failure rather than parse the message.
+         * Referenced only by the operations that emit these codes; every other operation
+         * keeps the plain `Error` shape.
+         *
+         */
+        export interface ConditionalPricingError {
+            /**
+             * Error message
+             */
+            message: string;
+            /**
+             * The HTTP status code
+             */
+            status?: number;
+            /**
+             * The cause of the error (visible for bad requests - http 400)
+             */
+            cause?: string;
+            /**
+             * The error message. Carries the same string as `message`, which the shared `Error`
+             * schema requires — `error` is the field responses have always used, and every caller
+             * to date reads. Declared here rather than on the shared `Error` because a request
+             * validation failure puts a list of validation errors in this field instead of a
+             * string, and those responses reference `Error` directly.
+             *
+             */
+            error?: string;
+            code?: /**
+             * Machine-readable failure mode of a conditional-pricing operation, allowing clients
+             * to branch on the kind of failure instead of parsing the error message.
+             *
+             * - `NOT_FOUND` (404): the addressed entity, variant or version does not exist
+             * - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
+             * - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
+             * - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
+             * - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
+             * - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
+             * - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
+             * - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
+             * - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
+             * - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
+             *
+             * Each code is emitted with the HTTP status shown above, and only with that status.
+             *
+             */
+            ConditionalPricingErrorCode;
+            /**
+             * Structured data about the failure, shaped by the accompanying `code`
+             * (e.g. the candidate variants of an `ambiguous-resolution`). Only present
+             * when the failure has structured data to report, and never without a `code`.
+             *
+             */
+            details?: {
+                [name: string]: any;
+            };
+        }
+        /**
+         * Machine-readable failure mode of a conditional-pricing operation, allowing clients
+         * to branch on the kind of failure instead of parsing the error message.
+         *
+         * - `NOT_FOUND` (404): the addressed entity, variant or version does not exist
+         * - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
+         * - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
+         * - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
+         * - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
+         * - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
+         * - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
+         * - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
+         * - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
+         * - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
+         *
+         * Each code is emitted with the HTTP status shown above, and only with that status.
+         *
+         */
+        export type ConditionalPricingErrorCode = "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "SUPERSEDED_VERSION" | "CONDITION_UNDEFINED" | "OPERATOR_UNSUPPORTED" | "CONTEXT_FORMAT_INVALID" | "TOO_MANY_MATCHES" | "WRITE_CONFLICT";
         export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
         /**
          * The coupon entity
@@ -9777,13 +9855,50 @@ declare namespace Components {
              *   "_updated_at": "2021-02-09T12:41:43.662Z"
              * }
              */
-            Tax;
+            Tax | /**
+             * A minimal, ad-hoc tax rate for line items with no backing tax entity
+             * in the catalog (e.g. a fully custom/composite price component built
+             * by a client with no product/price reference to resolve tax from).
+             * Mirrors how PriceItem relates to Price: unlike Tax, this has no
+             * entity identity — it isn't persisted and can't be looked up by _id,
+             * so it can't be shared/reused across price items the way a catalog
+             * Tax can.
+             *
+             * example:
+             * {
+             *   "rate": 19,
+             *   "type": "VAT",
+             *   "description": "Custom 19% VAT"
+             * }
+             */
+            TaxItem;
         }
         export interface TaxBreakdownInfo {
             rate?: number | null;
             type?: "VAT" | "GST" | "Custom";
             _id?: string;
         }
+        /**
+         * A minimal, ad-hoc tax rate for line items with no backing tax entity
+         * in the catalog (e.g. a fully custom/composite price component built
+         * by a client with no product/price reference to resolve tax from).
+         * Mirrors how PriceItem relates to Price: unlike Tax, this has no
+         * entity identity — it isn't persisted and can't be looked up by _id,
+         * so it can't be shared/reused across price items the way a catalog
+         * Tax can.
+         *
+         * example:
+         * {
+         *   "rate": 19,
+         *   "type": "VAT",
+         *   "description": "Custom 19% VAT"
+         * }
+         */
+        export interface TaxItem {
+            type: "VAT" | "GST" | "Custom";
+            rate: number | null;
+            description?: string;
+        }
         export interface TierDetails {
             quantity: number;
             unit_amount: number;
@@ -12034,6 +12149,8 @@ type ComputePriceResult = Components.Schemas.ComputePriceResult;
 type ComputedBasePrice = Components.Schemas.ComputedBasePrice;
 type ComputedPriceBreakdown = Components.Schemas.ComputedPriceBreakdown;
 type ComputedPriceComponents = Components.Schemas.ComputedPriceComponents;
+type ConditionalPricingError = Components.Schemas.ConditionalPricingError;
+type ConditionalPricingErrorCode = Components.Schemas.ConditionalPricingErrorCode;
 type ConsumptionTypeGetAg = Components.Schemas.ConsumptionTypeGetAg;
 type Coupon = Components.Schemas.Coupon;
 type CouponItem = Components.Schemas.CouponItem;
@@ -12138,10 +12255,11 @@ type TaxAmount = Components.Schemas.TaxAmount;
 type TaxAmountBreakdown = Components.Schemas.TaxAmountBreakdown;
 type TaxAmountDto = Components.Schemas.TaxAmountDto;
 type TaxBreakdownInfo = Components.Schemas.TaxBreakdownInfo;
+type TaxItem = Components.Schemas.TaxItem;
 type TierDetails = Components.Schemas.TierDetails;
 type TotalDetails = Components.Schemas.TotalDetails;
 type TypeGetAg = Components.Schemas.TypeGetAg;
 type ValidateAvailabilityFileError = Components.Schemas.ValidateAvailabilityFileError;
 type ValidateAvailabilityFileResult = Components.Schemas.ValidateAvailabilityFileResult;
 
-export { type DynamicTariffMode as $, type AdditionalProviderData as A, type BaseCompositePrice as B, type Client as C, type CheckoutCartResult as D, type CheckoutMode as E, type CompositePrice as F, type CompositePriceItem as G, type CompositePriceItemDto as H, type ComputePriceParams as I, type ComputePriceParamsBase as J, type ComputePriceParamsGas as K, type ComputePriceParamsPower as L, type ComputePriceResult as M, type ComputedBasePrice as N, type OperationMethods as O, Paths as P, type ComputedPriceBreakdown as Q, type ComputedPriceComponents as R, type ConsumptionTypeGetAg as S, type Coupon as T, type CouponItem as U, type CouponWithoutPromoCodes as V, type Currency as W, type CustomContext as X, type Customer as Y, type DiscountAmounts as Z, type DynamicTariffInterval as _, Components as a, type ProductCategory as a$, type EntityId as a0, type EntityItem as a1, type EntityRelation as a2, type Error as a3, type ExternalCatalogConfigurationRequest as a4, type ExternalCatalogCustomRequest as a5, type ExternalCatalogItem as a6, type ExternalCatalogJourneyRequest as a7, type ExternalCatalogPortalRequest as a8, type ExternalCatalogRequest as a9, type OrderPayload as aA, type OrderRelation as aB, type OrderSource as aC, type OrderStatus as aD, type PaymentMethod as aE, type PortalContext as aF, type PowerMarketAreaDetails as aG, type PowerMeterType as aH, type Price as aI, type PriceAmounts as aJ, type PriceComponentRelation as aK, type PriceConditions as aL, type PriceDynamicTariff as aM, type PriceGetAg as aN, type PriceInputMapping as aO, type PriceInputMappings as aP, type PriceItem as aQ, type PriceItemDto as aR, type PriceItemDtoUnion as aS, type PriceItems as aT, type PriceItemsDto as aU, type PriceTier as aV, type PriceTierDisplayMode as aW, type PricingDetails as aX, type PricingDetailsResponse as aY, type PricingModel as aZ, type Product as a_, type ExternalFeeMapping as aa, type ExternalFeeMappings as ab, type ExternalFeeMetadata as ac, type ExternalLocationMetadata as ad, type ExternalPriceMetadata as ae, type File as af, type GasConcessionType as ag, type GasMarketAreaDetails as ah, type HistoricMarketPriceRecord as ai, type HistoricMarketPricesResult as aj, type HydratedCompositePrice as ak, type IntegrationAuthCredentials as al, type IntegrationCredentialsResult as am, type IntegrationId as an, type JourneyContext as ao, type MarketParticipant as ap, type MarkupPricingModel as aq, type MetaData as ar, type NonHydratedCompositePrice as as, type OAuthCredentials as at, type OAuthIntegration as au, type Offer as av, type OfferHighlightConfig as aw, type Opportunity as ax, type OpportunitySource as ay, type Order as az, type PathsDictionary as b, type ProductRecommendation as b0, type ProductRecommendationResponse as b1, type ProductRecommendationSearch as b2, type PromoCode as b3, type PromoCodeValidationResponse as b4, type Provider as b5, type RecurrenceAmount as b6, type RecurrenceAmountDto as b7, type RecurrenceAmountWithTax as b8, type RedeemedPromo as b9, type SalesTax as ba, type SaveIntegrationCredentialsParams as bb, type SearchExternalCatalogParams as bc, type SearchExternalCatalogRecommendationsResult as bd, type SearchExternalCatalogResult as be, type SearchProvidersParams as bf, type SearchProvidersResult as bg, type SearchStreetsParams as bh, type SearchStreetsResult as bi, type SignatureMeta as bj, type SpotMarketBiddingZone as bk, type SpotMarketDataFrequency as bl, type SpotMarketType as bm, type Street as bn, type TariffTypeGetAg as bo, type Tax as bp, type TaxAmount as bq, type TaxAmountBreakdown as br, type TaxAmountDto as bs, type TaxBreakdownInfo as bt, type TierDetails as bu, type TotalDetails as bv, type TypeGetAg as bw, type ValidateAvailabilityFileError as bx, type ValidateAvailabilityFileResult as by, type Address as c, type Amounts as d, type AvailabilityCheckParams as e, type AvailabilityFilters as f, type AvailabilityLocation as g, type AvailabilityResult as h, type AverageMarketPriceRecord as i, type AverageMarketPriceResult as j, type BaseCouponCommon as k, type BaseMarketPriceRecord as l, type BasePriceItem as m, type BasePriceItemCommon as n, type BasePriceItemDto as o, type BasicAuthCredentials as p, type BasicAuthIntegration as q, type BillingPeriod as r, type CartDto as s, type CashbackAmount as t, type CashbackAmounts as u, type CashbackPeriod as v, type CatalogFieldsParam as w, type CatalogSearch as x, type CatalogSearchResult as y, type CheckoutCart as z };
+export { type DiscountAmounts as $, type AdditionalProviderData as A, type BaseCompositePrice as B, type Client as C, type CheckoutCartResult as D, type CheckoutMode as E, type CompositePrice as F, type CompositePriceItem as G, type CompositePriceItemDto as H, type ComputePriceParams as I, type ComputePriceParamsBase as J, type ComputePriceParamsGas as K, type ComputePriceParamsPower as L, type ComputePriceResult as M, type ComputedBasePrice as N, type OperationMethods as O, Paths as P, type ComputedPriceBreakdown as Q, type ComputedPriceComponents as R, type ConditionalPricingError as S, type ConditionalPricingErrorCode as T, type ConsumptionTypeGetAg as U, type Coupon as V, type CouponItem as W, type CouponWithoutPromoCodes as X, type Currency as Y, type CustomContext as Z, type Customer as _, Components as a, type PricingModel as a$, type DynamicTariffInterval as a0, type DynamicTariffMode as a1, type EntityId as a2, type EntityItem as a3, type EntityRelation as a4, type Error as a5, type ExternalCatalogConfigurationRequest as a6, type ExternalCatalogCustomRequest as a7, type ExternalCatalogItem as a8, type ExternalCatalogJourneyRequest as a9, type OpportunitySource as aA, type Order as aB, type OrderPayload as aC, type OrderRelation as aD, type OrderSource as aE, type OrderStatus as aF, type PaymentMethod as aG, type PortalContext as aH, type PowerMarketAreaDetails as aI, type PowerMeterType as aJ, type Price as aK, type PriceAmounts as aL, type PriceComponentRelation as aM, type PriceConditions as aN, type PriceDynamicTariff as aO, type PriceGetAg as aP, type PriceInputMapping as aQ, type PriceInputMappings as aR, type PriceItem as aS, type PriceItemDto as aT, type PriceItemDtoUnion as aU, type PriceItems as aV, type PriceItemsDto as aW, type PriceTier as aX, type PriceTierDisplayMode as aY, type PricingDetails as aZ, type PricingDetailsResponse as a_, type ExternalCatalogPortalRequest as aa, type ExternalCatalogRequest as ab, type ExternalFeeMapping as ac, type ExternalFeeMappings as ad, type ExternalFeeMetadata as ae, type ExternalLocationMetadata as af, type ExternalPriceMetadata as ag, type File as ah, type GasConcessionType as ai, type GasMarketAreaDetails as aj, type HistoricMarketPriceRecord as ak, type HistoricMarketPricesResult as al, type HydratedCompositePrice as am, type IntegrationAuthCredentials as an, type IntegrationCredentialsResult as ao, type IntegrationId as ap, type JourneyContext as aq, type MarketParticipant as ar, type MarkupPricingModel as as, type MetaData as at, type NonHydratedCompositePrice as au, type OAuthCredentials as av, type OAuthIntegration as aw, type Offer as ax, type OfferHighlightConfig as ay, type Opportunity as az, type PathsDictionary as b, type Product as b0, type ProductCategory as b1, type ProductRecommendation as b2, type ProductRecommendationResponse as b3, type ProductRecommendationSearch as b4, type PromoCode as b5, type PromoCodeValidationResponse as b6, type Provider as b7, type RecurrenceAmount as b8, type RecurrenceAmountDto as b9, type ValidateAvailabilityFileError as bA, type ValidateAvailabilityFileResult as bB, type RecurrenceAmountWithTax as ba, type RedeemedPromo as bb, type SalesTax as bc, type SaveIntegrationCredentialsParams as bd, type SearchExternalCatalogParams as be, type SearchExternalCatalogRecommendationsResult as bf, type SearchExternalCatalogResult as bg, type SearchProvidersParams as bh, type SearchProvidersResult as bi, type SearchStreetsParams as bj, type SearchStreetsResult as bk, type SignatureMeta as bl, type SpotMarketBiddingZone as bm, type SpotMarketDataFrequency as bn, type SpotMarketType as bo, type Street as bp, type TariffTypeGetAg as bq, type Tax as br, type TaxAmount as bs, type TaxAmountBreakdown as bt, type TaxAmountDto as bu, type TaxBreakdownInfo as bv, type TaxItem as bw, type TierDetails as bx, type TotalDetails as by, type TypeGetAg as bz, type Address as c, type Amounts as d, type AvailabilityCheckParams as e, type AvailabilityFilters as f, type AvailabilityLocation as g, type AvailabilityResult as h, type AverageMarketPriceRecord as i, type AverageMarketPriceResult as j, type BaseCouponCommon as k, type BaseMarketPriceRecord as l, type BasePriceItem as m, type BasePriceItemCommon as n, type BasePriceItemDto as o, type BasicAuthCredentials as p, type BasicAuthIntegration as q, type BillingPeriod as r, type CartDto as s, type CashbackAmount as t, type CashbackAmounts as u, type CashbackPeriod as v, type CatalogFieldsParam as w, type CatalogSearch as x, type CatalogSearchResult as y, type CheckoutCart as z };

package/docs/pricing.md

@@ -66,7 +66,9 @@ const { data } = await pricingClient.$calculatePricingDetails(...)
 
 **Schemas**
 - [`IntegrationId`](#integrationid)
+- [`ConditionalPricingErrorCode`](#conditionalpricingerrorcode)
 - [`Error`](#error)
+- [`ConditionalPricingError`](#conditionalpricingerror)
 - [`Product`](#product)
 - [`Opportunity`](#opportunity)
 - [`Order`](#order)
@@ -178,6 +180,7 @@ const { data } = await pricingClient.$calculatePricingDetails(...)
 - [`EntityItem`](#entityitem)
 - [`EntityRelation`](#entityrelation)
 - [`Tax`](#tax)
+- [`TaxItem`](#taxitem)
 - [`TaxBreakdownInfo`](#taxbreakdowninfo)
 - [`BaseCouponCommon`](#basecouponcommon)
 - [`CouponWithoutPromoCodes`](#couponwithoutpromocodes)
@@ -1782,6 +1785,18 @@ const { data } = await client.$productRecommendations(
 type IntegrationId = "getag" | "external-catalog"
 ```
 
+### `ConditionalPricingErrorCode`
+
+Machine-readable failure mode of a conditional-pricing operation, allowing clients
+to branch on the kind of failure instead of parsing the error message.
+
+- `NOT_FOUND` (404): the addressed entity, variant or version does not exist
+- `AMBIGUOUS_RESOLUTION` (409): several variants match the given con
+
+```ts
+type ConditionalPricingErrorCode = "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "SUPERSEDED_VERSION" | "CONDITION_UNDEFINED" | "OPERATOR_UNSUPPORTED" | "CONTEXT_FORMAT_INVALID" | "TOO_MANY_MATCHES" | "WRITE_CONFLICT"
+```
+
 ### `Error`
 
 ```ts
@@ -1792,6 +1807,24 @@ type Error = {
 }
 ```
 
+### `ConditionalPricingError`
+
+An error from a conditional-pricing operation, carrying a machine-readable `code`
+from the conditional-pricing vocabulary plus any structured data about the failure,
+so a client can branch on the kind of failure rather than parse the message.
+Referenced only by the operations that emit these codes; 
+
+```ts
+type ConditionalPricingError = {
+  message: string
+  status?: number
+  cause?: string
+  error?: string
+  code?: "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "SUPERSEDED_VERSION" | "CONDITION_UNDEFINED" | "OPERATOR_UNSUPPORTED" | "CONTEXT_FORMAT_INVALID" | "TOO_MANY_MATCHES" | "WRITE_CONFLICT"
+  details?: Record<string, unknown>
+}
+```
+
 ### `Product`
 
 The product entity
@@ -4175,6 +4208,10 @@ type TaxAmountDto = {
     active?: boolean
     region?: string
     region_label?: string
+  } | {
+    type: "VAT" | "GST" | "Custom"
+    rate: number
+    description?: string
   }
 }
 ```
@@ -5363,6 +5400,22 @@ type Tax = {
 }
 ```
 
+### `TaxItem`
+
+A minimal, ad-hoc tax rate for line items with no backing tax entity
+in the catalog (e.g. a fully custom/composite price component built
+by a client with no product/price reference to resolve tax from).
+Mirrors how PriceItem relates to Price: unlike Tax, this has no
+entity identity — it isn't persis
+
+```ts
+type TaxItem = {
+  type: "VAT" | "GST" | "Custom"
+  rate: number
+  description?: string
+}
+```
+
 ### `TaxBreakdownInfo`
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.15.8",
+  "version": "2.15.9",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",