@epilot/sdk 2.18.30 → 2.18.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/pricing-runtime.json +1 -1
- package/definitions/pricing.json +1733 -59
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +8 -8
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +2 -2
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-SH4WTF3U.cjs → chunk-JZBUH4RD.cjs} +2 -2
- package/dist/{chunk-63BFJKWV.js → chunk-OHYTCUUB.js} +1 -1
- package/dist/{chunk-VFIPZC47.js → chunk-RKEGU6OW.js} +2 -2
- package/dist/{chunk-KP7H52BF.cjs → chunk-UKHR33EL.cjs} +1 -1
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/pricing-HQ75T2TF.js +7 -0
- package/dist/pricing-HTU5XPZE.cjs +7 -0
- package/dist/{pricing-runtime-2YKEJJMZ.js → pricing-runtime-AT27C3BP.js} +1 -1
- package/dist/{pricing-runtime-XDCOKL47.cjs → pricing-runtime-PFVTRERK.cjs} +2 -2
- package/dist/{pricing.d-C95oaAtN.d.cts → pricing.d-D6HCZpbI.d.cts} +2218 -83
- package/dist/{pricing.d-C95oaAtN.d.ts → pricing.d-D6HCZpbI.d.ts} +2218 -83
- package/docs/pricing.md +1050 -22
- package/package.json +1 -1
- package/dist/pricing-5GBNQOLX.cjs +0 -7
- package/dist/pricing-YJHJTRJS.js +0 -7
|
@@ -164,6 +164,65 @@ declare namespace Components {
|
|
|
164
164
|
*/
|
|
165
165
|
before_discount_amount_subtotal_decimal?: string;
|
|
166
166
|
}
|
|
167
|
+
export interface AppendVersionRequest {
|
|
168
|
+
/**
|
|
169
|
+
* When this version takes effect. Defaults to now.
|
|
170
|
+
*
|
|
171
|
+
* An RFC 3339 date (`2026-01-01`, read as midnight UTC) or date-time
|
|
172
|
+
* (`2026-01-01T00:00:00Z`), to at most millisecond precision. Deliberately not declared as
|
|
173
|
+
* `format: date-time`, which would reject the plain-date form that this accepts.
|
|
174
|
+
*
|
|
175
|
+
* A date in the past is accepted and answered with warnings, never refused. A date the
|
|
176
|
+
* variant already has a version at is refused as `VERSION_CONFLICT`.
|
|
177
|
+
*
|
|
178
|
+
* **Omit this to mean "now"** — that is the only spelling of now that is reliably silent. A
|
|
179
|
+
* timestamp taken from the caller's own clock is already some milliseconds old when the
|
|
180
|
+
* server judges it, which makes it a backdate, however small, and it is answered with the
|
|
181
|
+
* warnings a backdate earns.
|
|
182
|
+
*
|
|
183
|
+
* example:
|
|
184
|
+
* 2027-01-01T00:00:00Z
|
|
185
|
+
*/
|
|
186
|
+
valid_from?: string;
|
|
187
|
+
values: /**
|
|
188
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
189
|
+
*
|
|
190
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
191
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
192
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
193
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
194
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
195
|
+
* variant may override it.
|
|
196
|
+
*
|
|
197
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
198
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
199
|
+
* then reactivates the same override.
|
|
200
|
+
*
|
|
201
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
202
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
203
|
+
* set, with no special handling.
|
|
204
|
+
*
|
|
205
|
+
* example:
|
|
206
|
+
* {
|
|
207
|
+
* "unit_amount": 2499,
|
|
208
|
+
* "unit_amount_decimal": "24.99"
|
|
209
|
+
* }
|
|
210
|
+
*/
|
|
211
|
+
VariantValues;
|
|
212
|
+
/**
|
|
213
|
+
* Optional, and never applied: a variant's conditions are fixed when it is created. Accepted
|
|
214
|
+
* only so that a client building its body from the version it loaded is not forced to strip
|
|
215
|
+
* them out, and refused when they describe a different situation from the stored one.
|
|
216
|
+
*
|
|
217
|
+
* example:
|
|
218
|
+
* {
|
|
219
|
+
* "postal_code": "46045"
|
|
220
|
+
* }
|
|
221
|
+
*/
|
|
222
|
+
conditions?: {
|
|
223
|
+
[name: string]: any;
|
|
224
|
+
};
|
|
225
|
+
}
|
|
167
226
|
/**
|
|
168
227
|
* Availability check request payload
|
|
169
228
|
*/
|
|
@@ -4111,6 +4170,144 @@ declare namespace Components {
|
|
|
4111
4170
|
export interface ComputedPriceComponents {
|
|
4112
4171
|
[name: string]: /* The computed price */ ComputedBasePrice;
|
|
4113
4172
|
}
|
|
4173
|
+
/**
|
|
4174
|
+
* One condition dimension, in the shape a schema's `conditions` array holds it — copy it in
|
|
4175
|
+
* verbatim.
|
|
4176
|
+
*
|
|
4177
|
+
*/
|
|
4178
|
+
export interface ConditionDefinition {
|
|
4179
|
+
/**
|
|
4180
|
+
* How variants and resolve contexts refer to this condition. Independent of attribute
|
|
4181
|
+
* names: a value needed as an attribute too is duplicated onto the variant.
|
|
4182
|
+
*
|
|
4183
|
+
* `default`, and any name beginning with `_`, are reserved for the server: a condition
|
|
4184
|
+
* declared under one is ignored, since nothing could pin it and no context could address it.
|
|
4185
|
+
*
|
|
4186
|
+
* example:
|
|
4187
|
+
* postal_code
|
|
4188
|
+
*/
|
|
4189
|
+
name: string;
|
|
4190
|
+
/**
|
|
4191
|
+
* Human-readable name of the condition.
|
|
4192
|
+
* example:
|
|
4193
|
+
* Postal Code
|
|
4194
|
+
*/
|
|
4195
|
+
label: string;
|
|
4196
|
+
type: /**
|
|
4197
|
+
* The kind of value a condition holds, which decides how a variant's pinned value is matched
|
|
4198
|
+
* against a resolve context.
|
|
4199
|
+
*
|
|
4200
|
+
* - `string`: an arbitrary string, matched exactly and case-sensitively
|
|
4201
|
+
* - `number`: a numeric value
|
|
4202
|
+
* - `date`: a single date
|
|
4203
|
+
* - `daterange`: a window with a from and an until timestamp; both ends may be left open
|
|
4204
|
+
* - `boolean`: a true/false value
|
|
4205
|
+
* - `select`: one of the values declared in `options`, unless `allow_any` is set
|
|
4206
|
+
* - `location`: a geographic value, shaped by `format`
|
|
4207
|
+
*
|
|
4208
|
+
* There is no condition type for the fallback variant. Being the entity's fallback is a
|
|
4209
|
+
* property of the variant, set by the `default` flag on a variant write, and needs nothing
|
|
4210
|
+
* declared in the schema.
|
|
4211
|
+
*
|
|
4212
|
+
*/
|
|
4213
|
+
ConditionType;
|
|
4214
|
+
/**
|
|
4215
|
+
* The declared vocabulary of a `select` condition. Absent for every other type.
|
|
4216
|
+
*
|
|
4217
|
+
* The same shape a `select` attribute's `options` has on the Entity API, item for item: an
|
|
4218
|
+
* entry is either the value itself or an object carrying that value and an optional display
|
|
4219
|
+
* `title`. A `title` is never pinned by a variant and never matched — two entries differing
|
|
4220
|
+
* only in their title are one vocabulary entry.
|
|
4221
|
+
*
|
|
4222
|
+
* Enforced on variant writes, unless `allow_any` is true: a pinned value outside the
|
|
4223
|
+
* vocabulary is rejected with `CONDITION_VALUE_INVALID`. It is *not* enforced on resolve —
|
|
4224
|
+
* a vocabulary says what may be stored, not what may be asked for, so a context value
|
|
4225
|
+
* outside it is a query that simply matches nothing.
|
|
4226
|
+
*
|
|
4227
|
+
* example:
|
|
4228
|
+
* [
|
|
4229
|
+
* "private",
|
|
4230
|
+
* "commercial"
|
|
4231
|
+
* ]
|
|
4232
|
+
*/
|
|
4233
|
+
options?: ((string | null) | {
|
|
4234
|
+
value: string;
|
|
4235
|
+
title?: string;
|
|
4236
|
+
})[];
|
|
4237
|
+
/**
|
|
4238
|
+
* Allow arbitrary stored values in addition to the declared `options`. Absent means strict:
|
|
4239
|
+
* a variant may only pin a declared option.
|
|
4240
|
+
*
|
|
4241
|
+
* example:
|
|
4242
|
+
* false
|
|
4243
|
+
*/
|
|
4244
|
+
allow_any?: boolean;
|
|
4245
|
+
/**
|
|
4246
|
+
* The value shape of a `location` condition. Absent for every other type.
|
|
4247
|
+
*/
|
|
4248
|
+
format?: "zipcode" | "zipcode + town";
|
|
4249
|
+
}
|
|
4250
|
+
/**
|
|
4251
|
+
* A named bundle of condition definitions, built in for one entity type.
|
|
4252
|
+
*/
|
|
4253
|
+
export interface ConditionSet {
|
|
4254
|
+
/**
|
|
4255
|
+
* Identifies the set within this entity type's catalog.
|
|
4256
|
+
* example:
|
|
4257
|
+
* delivery_area
|
|
4258
|
+
*/
|
|
4259
|
+
id: string;
|
|
4260
|
+
/**
|
|
4261
|
+
* Human-readable name of the set.
|
|
4262
|
+
* example:
|
|
4263
|
+
* Delivery Area
|
|
4264
|
+
*/
|
|
4265
|
+
label: string;
|
|
4266
|
+
/**
|
|
4267
|
+
* What the set is for, and when to reach for it.
|
|
4268
|
+
*/
|
|
4269
|
+
description: string;
|
|
4270
|
+
/**
|
|
4271
|
+
* The condition definitions to copy into the schema's own `conditions` array.
|
|
4272
|
+
*/
|
|
4273
|
+
conditions: /**
|
|
4274
|
+
* One condition dimension, in the shape a schema's `conditions` array holds it — copy it in
|
|
4275
|
+
* verbatim.
|
|
4276
|
+
*
|
|
4277
|
+
*/
|
|
4278
|
+
ConditionDefinition[];
|
|
4279
|
+
}
|
|
4280
|
+
export interface ConditionSetCatalog {
|
|
4281
|
+
/**
|
|
4282
|
+
* The condition sets built in for the requested entity type, in the order they are offered.
|
|
4283
|
+
*
|
|
4284
|
+
*/
|
|
4285
|
+
results: /* A named bundle of condition definitions, built in for one entity type. */ ConditionSet[];
|
|
4286
|
+
}
|
|
4287
|
+
/**
|
|
4288
|
+
* The kind of value a condition holds, which decides how a variant's pinned value is matched
|
|
4289
|
+
* against a resolve context.
|
|
4290
|
+
*
|
|
4291
|
+
* - `string`: an arbitrary string, matched exactly and case-sensitively
|
|
4292
|
+
* - `number`: a numeric value
|
|
4293
|
+
* - `date`: a single date
|
|
4294
|
+
* - `daterange`: a window with a from and an until timestamp; both ends may be left open
|
|
4295
|
+
* - `boolean`: a true/false value
|
|
4296
|
+
* - `select`: one of the values declared in `options`, unless `allow_any` is set
|
|
4297
|
+
* - `location`: a geographic value, shaped by `format`
|
|
4298
|
+
*
|
|
4299
|
+
* There is no condition type for the fallback variant. Being the entity's fallback is a
|
|
4300
|
+
* property of the variant, set by the `default` flag on a variant write, and needs nothing
|
|
4301
|
+
* declared in the schema.
|
|
4302
|
+
*
|
|
4303
|
+
*/
|
|
4304
|
+
export type ConditionType = "string" | "number" | "date" | "daterange" | "boolean" | "select" | "location";
|
|
4305
|
+
/**
|
|
4306
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
4307
|
+
* conditional-pricing route.
|
|
4308
|
+
*
|
|
4309
|
+
*/
|
|
4310
|
+
export type ConditionalEntitySlug = "product" | "price" | "coupon";
|
|
4114
4311
|
/**
|
|
4115
4312
|
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
4116
4313
|
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
@@ -4149,10 +4346,10 @@ declare namespace Components {
|
|
|
4149
4346
|
* - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
|
|
4150
4347
|
* - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
|
|
4151
4348
|
* - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
|
|
4152
|
-
* - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
|
|
4153
4349
|
* - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
|
|
4154
4350
|
* - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
|
|
4155
4351
|
* - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
|
|
4352
|
+
* - `CONDITION_VALUE_INVALID` (400): a variant write pins a `select` value the condition's declared `options` do not contain
|
|
4156
4353
|
* - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
|
|
4157
4354
|
* - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
|
|
4158
4355
|
*
|
|
@@ -4178,17 +4375,17 @@ declare namespace Components {
|
|
|
4178
4375
|
* - `AMBIGUOUS_RESOLUTION` (409): several variants match the given context while a single result was requested
|
|
4179
4376
|
* - `TUPLE_CONFLICT` (409): the condition tuple is already claimed by another variant
|
|
4180
4377
|
* - `VERSION_CONFLICT` (409): a version already exists at the given `valid_from` on that variant
|
|
4181
|
-
* - `SUPERSEDED_VERSION` (409): the addressed version has been superseded
|
|
4182
4378
|
* - `CONDITION_UNDEFINED` (400): the context names a condition the entity's schema does not define
|
|
4183
4379
|
* - `OPERATOR_UNSUPPORTED` (400): the requested operator is not applicable to the condition's type
|
|
4184
4380
|
* - `CONTEXT_FORMAT_INVALID` (400): a context value is malformed for its condition type
|
|
4381
|
+
* - `CONDITION_VALUE_INVALID` (400): a variant write pins a `select` value the condition's declared `options` do not contain
|
|
4185
4382
|
* - `TOO_MANY_MATCHES` (400): a multi-match resolve exceeded its result cap
|
|
4186
4383
|
* - `WRITE_CONFLICT` (409): transient write contention, retryable unlike `TUPLE_CONFLICT`
|
|
4187
4384
|
*
|
|
4188
4385
|
* Each code is emitted with the HTTP status shown above, and only with that status.
|
|
4189
4386
|
*
|
|
4190
4387
|
*/
|
|
4191
|
-
export type ConditionalPricingErrorCode = "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "
|
|
4388
|
+
export type ConditionalPricingErrorCode = "NOT_FOUND" | "AMBIGUOUS_RESOLUTION" | "TUPLE_CONFLICT" | "VERSION_CONFLICT" | "CONDITION_UNDEFINED" | "OPERATOR_UNSUPPORTED" | "CONTEXT_FORMAT_INVALID" | "CONDITION_VALUE_INVALID" | "TOO_MANY_MATCHES" | "WRITE_CONFLICT";
|
|
4192
4389
|
export type ConsumptionTypeGetAg = "household" | "heating_pump" | "night_storage_heating" | "night_storage_heating_common_meter";
|
|
4193
4390
|
/**
|
|
4194
4391
|
* The coupon entity
|
|
@@ -4513,6 +4710,163 @@ declare namespace Components {
|
|
|
4513
4710
|
*/
|
|
4514
4711
|
Price[];
|
|
4515
4712
|
}
|
|
4713
|
+
export interface CreateVariantRequest {
|
|
4714
|
+
conditions?: /**
|
|
4715
|
+
* The situation this variant applies to: a flat map keyed by condition name, as the entity's
|
|
4716
|
+
* schema declares them. A condition left out is a wildcard — the variant applies whatever the
|
|
4717
|
+
* context says for it, which is what makes adding a condition to a schema non-breaking for the
|
|
4718
|
+
* variants that already exist.
|
|
4719
|
+
*
|
|
4720
|
+
* Exact values only. Predicates are accepted in a resolve context and nowhere else, so that
|
|
4721
|
+
* matching is decided in exactly one place.
|
|
4722
|
+
*
|
|
4723
|
+
* Values are typed by their condition and stored canonicalized for that type: a `date` becomes
|
|
4724
|
+
* millisecond-precision UTC, a `daterange` an object carrying `from` and `until` where an empty
|
|
4725
|
+
* string is an open end, a `location` of format `zipcode` the postal code itself and one of
|
|
4726
|
+
* format `zipcode + town` an object carrying both. A `select` value must be a string, and must
|
|
4727
|
+
* be one the condition's `options` declare unless it sets `allow_any`.
|
|
4728
|
+
*
|
|
4729
|
+
* `default`, and any name beginning with `_`, are reserved for the server and cannot be pinned
|
|
4730
|
+
* here. Whether a variant is the entity's fallback is set through the request's `default` flag.
|
|
4731
|
+
*
|
|
4732
|
+
* example:
|
|
4733
|
+
* {
|
|
4734
|
+
* "postal_code": "46045"
|
|
4735
|
+
* }
|
|
4736
|
+
*/
|
|
4737
|
+
PinnedConditions;
|
|
4738
|
+
/**
|
|
4739
|
+
* Mark this variant as the entity's fallback: the one served when no other variant applies.
|
|
4740
|
+
*
|
|
4741
|
+
* A property of the variant, never an entry in `conditions` — a variant claiming a value for
|
|
4742
|
+
* the marker would hold a real condition tuple while being permanently unmatchable, since no
|
|
4743
|
+
* resolve context ever supplies it. A default variant cannot pin anything else, and an
|
|
4744
|
+
* entity can have at most one.
|
|
4745
|
+
*
|
|
4746
|
+
* Available to every conditional entity: nothing has to be declared in the schema first.
|
|
4747
|
+
* The variant is stored pinning one reserved condition, which is what makes the ordinary
|
|
4748
|
+
* condition-tuple guard enforce at-most-one-per-entity with no rule of its own.
|
|
4749
|
+
*
|
|
4750
|
+
*/
|
|
4751
|
+
default?: boolean;
|
|
4752
|
+
/**
|
|
4753
|
+
* When the first version takes effect. Defaults to now.
|
|
4754
|
+
*
|
|
4755
|
+
* An RFC 3339 date (`2026-01-01`, read as midnight UTC) or date-time
|
|
4756
|
+
* (`2026-01-01T00:00:00Z`), to at most millisecond precision. Deliberately not declared as
|
|
4757
|
+
* `format: date-time`, which would reject the plain-date form that this accepts.
|
|
4758
|
+
*
|
|
4759
|
+
* example:
|
|
4760
|
+
* 2027-01-01T00:00:00Z
|
|
4761
|
+
*/
|
|
4762
|
+
valid_from?: string;
|
|
4763
|
+
values: /**
|
|
4764
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
4765
|
+
*
|
|
4766
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
4767
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
4768
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
4769
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
4770
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
4771
|
+
* variant may override it.
|
|
4772
|
+
*
|
|
4773
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
4774
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
4775
|
+
* then reactivates the same override.
|
|
4776
|
+
*
|
|
4777
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
4778
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
4779
|
+
* set, with no special handling.
|
|
4780
|
+
*
|
|
4781
|
+
* example:
|
|
4782
|
+
* {
|
|
4783
|
+
* "unit_amount": 2499,
|
|
4784
|
+
* "unit_amount_decimal": "24.99"
|
|
4785
|
+
* }
|
|
4786
|
+
*/
|
|
4787
|
+
VariantValues;
|
|
4788
|
+
}
|
|
4789
|
+
export interface CreatedVariant {
|
|
4790
|
+
/**
|
|
4791
|
+
* Server-generated, always. This is the durable key orders and contracts pin, so it is never
|
|
4792
|
+
* accepted from a client — a client-suppliable id would risk collisions between independent
|
|
4793
|
+
* importers.
|
|
4794
|
+
*
|
|
4795
|
+
* example:
|
|
4796
|
+
* var-46045
|
|
4797
|
+
*/
|
|
4798
|
+
variant_id: string;
|
|
4799
|
+
/**
|
|
4800
|
+
* example:
|
|
4801
|
+
* price-sp26d1yo
|
|
4802
|
+
*/
|
|
4803
|
+
entity_id: string;
|
|
4804
|
+
schema: /**
|
|
4805
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
4806
|
+
* conditional-pricing route.
|
|
4807
|
+
*
|
|
4808
|
+
*/
|
|
4809
|
+
ConditionalEntitySlug;
|
|
4810
|
+
/**
|
|
4811
|
+
* The situation this variant applies to, plus the boolean `default` discriminator — the
|
|
4812
|
+
* same shape `_conditions` has on a resolved payload.
|
|
4813
|
+
*
|
|
4814
|
+
* example:
|
|
4815
|
+
* {
|
|
4816
|
+
* "postal_code": "46045",
|
|
4817
|
+
* "default": false
|
|
4818
|
+
* }
|
|
4819
|
+
*/
|
|
4820
|
+
conditions: {
|
|
4821
|
+
[name: string]: any;
|
|
4822
|
+
default: boolean;
|
|
4823
|
+
};
|
|
4824
|
+
/**
|
|
4825
|
+
* When the first version takes effect, canonicalized to millisecond-precision UTC.
|
|
4826
|
+
* example:
|
|
4827
|
+
* 2027-01-01T00:00:00.000Z
|
|
4828
|
+
*/
|
|
4829
|
+
valid_from: string;
|
|
4830
|
+
values: /**
|
|
4831
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
4832
|
+
*
|
|
4833
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
4834
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
4835
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
4836
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
4837
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
4838
|
+
* variant may override it.
|
|
4839
|
+
*
|
|
4840
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
4841
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
4842
|
+
* then reactivates the same override.
|
|
4843
|
+
*
|
|
4844
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
4845
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
4846
|
+
* set, with no special handling.
|
|
4847
|
+
*
|
|
4848
|
+
* example:
|
|
4849
|
+
* {
|
|
4850
|
+
* "unit_amount": 2499,
|
|
4851
|
+
* "unit_amount_decimal": "24.99"
|
|
4852
|
+
* }
|
|
4853
|
+
*/
|
|
4854
|
+
VariantValues;
|
|
4855
|
+
_created_at?: string;
|
|
4856
|
+
_updated_at?: string;
|
|
4857
|
+
/**
|
|
4858
|
+
* The revision a later write to this version must carry to be accepted. Genuinely current,
|
|
4859
|
+
* unlike one read back later from an eventually-consistent read.
|
|
4860
|
+
*
|
|
4861
|
+
*/
|
|
4862
|
+
_revision?: number;
|
|
4863
|
+
/**
|
|
4864
|
+
* Things worth knowing that did not stop the write. Empty in the ordinary case — a client
|
|
4865
|
+
* reads its length rather than branching on its absence.
|
|
4866
|
+
*
|
|
4867
|
+
*/
|
|
4868
|
+
warnings: VariantWriteWarning[];
|
|
4869
|
+
}
|
|
4516
4870
|
/**
|
|
4517
4871
|
* Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
|
4518
4872
|
* ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
|
|
@@ -4542,6 +4896,70 @@ declare namespace Components {
|
|
|
4542
4896
|
email?: string;
|
|
4543
4897
|
phone?: string;
|
|
4544
4898
|
}
|
|
4899
|
+
export interface DeletedVariant {
|
|
4900
|
+
/**
|
|
4901
|
+
* example:
|
|
4902
|
+
* var-46045
|
|
4903
|
+
*/
|
|
4904
|
+
variant_id: string;
|
|
4905
|
+
/**
|
|
4906
|
+
* example:
|
|
4907
|
+
* price-sp26d1yo
|
|
4908
|
+
*/
|
|
4909
|
+
entity_id: string;
|
|
4910
|
+
schema: /**
|
|
4911
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
4912
|
+
* conditional-pricing route.
|
|
4913
|
+
*
|
|
4914
|
+
*/
|
|
4915
|
+
ConditionalEntitySlug;
|
|
4916
|
+
/**
|
|
4917
|
+
* Whether this call is the one that freed the variant's combination of condition values.
|
|
4918
|
+
* `false` where an earlier, interrupted attempt had already freed it — the delete still
|
|
4919
|
+
* succeeded, and the combination was already reusable.
|
|
4920
|
+
*
|
|
4921
|
+
*/
|
|
4922
|
+
tuple_released: boolean;
|
|
4923
|
+
/**
|
|
4924
|
+
* Version rows this call removed.
|
|
4925
|
+
*/
|
|
4926
|
+
versions_deleted: number;
|
|
4927
|
+
}
|
|
4928
|
+
export interface DeletedVariantVersion {
|
|
4929
|
+
/**
|
|
4930
|
+
* example:
|
|
4931
|
+
* var-46045
|
|
4932
|
+
*/
|
|
4933
|
+
variant_id: string;
|
|
4934
|
+
/**
|
|
4935
|
+
* example:
|
|
4936
|
+
* price-sp26d1yo
|
|
4937
|
+
*/
|
|
4938
|
+
entity_id: string;
|
|
4939
|
+
schema: /**
|
|
4940
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
4941
|
+
* conditional-pricing route.
|
|
4942
|
+
*
|
|
4943
|
+
*/
|
|
4944
|
+
ConditionalEntitySlug;
|
|
4945
|
+
/**
|
|
4946
|
+
* The version removed, canonicalized to millisecond-precision UTC.
|
|
4947
|
+
* example:
|
|
4948
|
+
* 2027-01-01T00:00:00.000Z
|
|
4949
|
+
*/
|
|
4950
|
+
valid_from: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* What the delete moved, if anything. Empty when a scheduled version was withdrawn.
|
|
4953
|
+
*/
|
|
4954
|
+
warnings: /**
|
|
4955
|
+
* Something a version write moved. A version write is never refused for being late — backdating a
|
|
4956
|
+
* version, and editing or deleting one that has already been superseded, are both accepted — so
|
|
4957
|
+
* what a caller gets instead is a warning naming exactly what changed. One write can carry both
|
|
4958
|
+
* codes.
|
|
4959
|
+
*
|
|
4960
|
+
*/
|
|
4961
|
+
VersionWriteWarning[];
|
|
4962
|
+
}
|
|
4545
4963
|
export interface DiscountAmounts {
|
|
4546
4964
|
/**
|
|
4547
4965
|
* The discount amount.
|
|
@@ -6771,6 +7189,47 @@ declare namespace Components {
|
|
|
6771
7189
|
*
|
|
6772
7190
|
*/
|
|
6773
7191
|
export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "completed";
|
|
7192
|
+
export interface PatchVersionRequest {
|
|
7193
|
+
/**
|
|
7194
|
+
* Only the attribute overrides to change. Everything not mentioned is left as stored.
|
|
7195
|
+
*
|
|
7196
|
+
* `null` is a value like any other here rather than a deletion; to stop overriding an
|
|
7197
|
+
* attribute, send the complete snapshot without it through the replace operation.
|
|
7198
|
+
*
|
|
7199
|
+
* example:
|
|
7200
|
+
* {
|
|
7201
|
+
* "unit_amount": 2499,
|
|
7202
|
+
* "unit_amount_decimal": "24.99"
|
|
7203
|
+
* }
|
|
7204
|
+
*/
|
|
7205
|
+
values: {
|
|
7206
|
+
[name: string]: any;
|
|
7207
|
+
};
|
|
7208
|
+
/**
|
|
7209
|
+
* The revision marker read from the version being written. The write is refused with
|
|
7210
|
+
* `WRITE_CONFLICT` if the version has been written since.
|
|
7211
|
+
*
|
|
7212
|
+
* example:
|
|
7213
|
+
* 3
|
|
7214
|
+
*/
|
|
7215
|
+
_revision: number;
|
|
7216
|
+
/**
|
|
7217
|
+
* Optional, never applied, and refused when it names a version other than the one addressed.
|
|
7218
|
+
*/
|
|
7219
|
+
valid_from?: string;
|
|
7220
|
+
/**
|
|
7221
|
+
* Optional, and never applied. A partial update that tries to change a pinned condition value
|
|
7222
|
+
* is refused — this is the path that rule is most likely to be broken on by accident.
|
|
7223
|
+
*
|
|
7224
|
+
* example:
|
|
7225
|
+
* {
|
|
7226
|
+
* "postal_code": "46045"
|
|
7227
|
+
* }
|
|
7228
|
+
*/
|
|
7229
|
+
conditions?: {
|
|
7230
|
+
[name: string]: any;
|
|
7231
|
+
};
|
|
7232
|
+
}
|
|
6774
7233
|
/**
|
|
6775
7234
|
* A PaymentMethod represent your customer's payment instruments.
|
|
6776
7235
|
*
|
|
@@ -6787,6 +7246,32 @@ declare namespace Components {
|
|
|
6787
7246
|
[name: string]: any;
|
|
6788
7247
|
};
|
|
6789
7248
|
}
|
|
7249
|
+
/**
|
|
7250
|
+
* The situation this variant applies to: a flat map keyed by condition name, as the entity's
|
|
7251
|
+
* schema declares them. A condition left out is a wildcard — the variant applies whatever the
|
|
7252
|
+
* context says for it, which is what makes adding a condition to a schema non-breaking for the
|
|
7253
|
+
* variants that already exist.
|
|
7254
|
+
*
|
|
7255
|
+
* Exact values only. Predicates are accepted in a resolve context and nowhere else, so that
|
|
7256
|
+
* matching is decided in exactly one place.
|
|
7257
|
+
*
|
|
7258
|
+
* Values are typed by their condition and stored canonicalized for that type: a `date` becomes
|
|
7259
|
+
* millisecond-precision UTC, a `daterange` an object carrying `from` and `until` where an empty
|
|
7260
|
+
* string is an open end, a `location` of format `zipcode` the postal code itself and one of
|
|
7261
|
+
* format `zipcode + town` an object carrying both. A `select` value must be a string, and must
|
|
7262
|
+
* be one the condition's `options` declare unless it sets `allow_any`.
|
|
7263
|
+
*
|
|
7264
|
+
* `default`, and any name beginning with `_`, are reserved for the server and cannot be pinned
|
|
7265
|
+
* here. Whether a variant is the entity's fallback is set through the request's `default` flag.
|
|
7266
|
+
*
|
|
7267
|
+
* example:
|
|
7268
|
+
* {
|
|
7269
|
+
* "postal_code": "46045"
|
|
7270
|
+
* }
|
|
7271
|
+
*/
|
|
7272
|
+
export interface PinnedConditions {
|
|
7273
|
+
[name: string]: any;
|
|
7274
|
+
}
|
|
6790
7275
|
export interface PortalContext {
|
|
6791
7276
|
[name: string]: any;
|
|
6792
7277
|
/**
|
|
@@ -9617,42 +10102,261 @@ declare namespace Components {
|
|
|
9617
10102
|
*/
|
|
9618
10103
|
CouponWithoutPromoCodes[];
|
|
9619
10104
|
}
|
|
9620
|
-
export
|
|
9621
|
-
export type SaveIntegrationCredentialsParams = /* The auth credentials for external integrations */ IntegrationAuthCredentials;
|
|
9622
|
-
export interface SearchExternalCatalogParams {
|
|
9623
|
-
context: JourneyContext;
|
|
9624
|
-
}
|
|
9625
|
-
export interface SearchExternalCatalogRecommendationsResult {
|
|
9626
|
-
source: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem;
|
|
9627
|
-
offers: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
|
|
9628
|
-
}
|
|
9629
|
-
export interface SearchExternalCatalogResult {
|
|
9630
|
-
/**
|
|
9631
|
-
* The number of results returned.
|
|
9632
|
-
*/
|
|
9633
|
-
hits: number;
|
|
9634
|
-
results: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
|
|
9635
|
-
}
|
|
9636
|
-
/**
|
|
9637
|
-
* A search providers payload
|
|
9638
|
-
*/
|
|
9639
|
-
export interface SearchProvidersParams {
|
|
10105
|
+
export interface ReplaceVersionRequest {
|
|
9640
10106
|
/**
|
|
9641
|
-
* The
|
|
10107
|
+
* The complete set of attribute overrides this version carries. An overridable attribute
|
|
10108
|
+
* absent from here stops being overridden.
|
|
10109
|
+
*
|
|
10110
|
+
* Attributes the variant may not override are ignored where this carries them, and their
|
|
10111
|
+
* **stored value is kept rather than dropped** — otherwise a routine full-snapshot write
|
|
10112
|
+
* would erase an override the moment its attribute's `overridable_attribute`, `readonly` or
|
|
10113
|
+
* `hidden` flag happened to be off.
|
|
10114
|
+
*
|
|
10115
|
+
* example:
|
|
10116
|
+
* {
|
|
10117
|
+
* "unit_amount": 2499,
|
|
10118
|
+
* "unit_amount_decimal": "24.99"
|
|
10119
|
+
* }
|
|
9642
10120
|
*/
|
|
9643
|
-
|
|
10121
|
+
values: {
|
|
10122
|
+
[name: string]: any;
|
|
10123
|
+
};
|
|
9644
10124
|
/**
|
|
9645
|
-
* The
|
|
10125
|
+
* The revision marker read from the version being written. The write is refused with
|
|
10126
|
+
* `WRITE_CONFLICT` if the version has been written since.
|
|
10127
|
+
*
|
|
10128
|
+
* Required rather than optional: an optional one is a guarantee every client can opt out of
|
|
10129
|
+
* by forgetting a field, and the write it protects is the one that overwrites somebody
|
|
10130
|
+
* else's edit.
|
|
10131
|
+
*
|
|
10132
|
+
* example:
|
|
10133
|
+
* 3
|
|
9646
10134
|
*/
|
|
9647
|
-
|
|
10135
|
+
_revision: number;
|
|
9648
10136
|
/**
|
|
9649
|
-
*
|
|
10137
|
+
* Optional, and never applied. Accepted when it names the version being addressed — so a
|
|
10138
|
+
* client building its body from what it loaded need not strip it out — and refused when it
|
|
10139
|
+
* names another: a version's `valid_from` is its identity, and moving it is an append and a
|
|
10140
|
+
* delete rather than an edit.
|
|
10141
|
+
*
|
|
9650
10142
|
*/
|
|
9651
|
-
|
|
10143
|
+
valid_from?: string;
|
|
9652
10144
|
/**
|
|
9653
|
-
*
|
|
10145
|
+
* Optional, and never applied: a variant's conditions are fixed when it is created. Refused
|
|
10146
|
+
* when they describe a different situation from the stored one.
|
|
10147
|
+
*
|
|
10148
|
+
* example:
|
|
10149
|
+
* {
|
|
10150
|
+
* "postal_code": "46045"
|
|
10151
|
+
* }
|
|
9654
10152
|
*/
|
|
9655
|
-
|
|
10153
|
+
conditions?: {
|
|
10154
|
+
[name: string]: any;
|
|
10155
|
+
};
|
|
10156
|
+
}
|
|
10157
|
+
export interface ResolveConditionalEntityRequest {
|
|
10158
|
+
schema: /**
|
|
10159
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
10160
|
+
* conditional-pricing route.
|
|
10161
|
+
*
|
|
10162
|
+
*/
|
|
10163
|
+
ConditionalEntitySlug;
|
|
10164
|
+
/**
|
|
10165
|
+
* The conditional entity to resolve. Resolution is always scoped to exactly one.
|
|
10166
|
+
* example:
|
|
10167
|
+
* price-sp26d1yo
|
|
10168
|
+
*/
|
|
10169
|
+
entity_id: string;
|
|
10170
|
+
context?: /**
|
|
10171
|
+
* The situation to resolve for: a flat map keyed by condition name, as the entity's schema
|
|
10172
|
+
* declares them. A condition left out of the map is not a wildcard — it matches only variants
|
|
10173
|
+
* that leave that condition unpinned.
|
|
10174
|
+
*
|
|
10175
|
+
* Each value is either an exact value, typed by its condition, or a single-operator predicate
|
|
10176
|
+
* object:
|
|
10177
|
+
*
|
|
10178
|
+
* - `{ "lt": v }`, `{ "lte": v }`, `{ "gt": v }`, `{ "gte": v }` — order against a `number` or
|
|
10179
|
+
* `date` condition.
|
|
10180
|
+
* - `{ "in": [...] }` — membership, against a `string`, `select` or `number` condition.
|
|
10181
|
+
* - `{ "between": "2026-03-01" }` — the explicit spelling of `daterange` containment; a plain
|
|
10182
|
+
* date supplied for a `daterange` condition means the same thing.
|
|
10183
|
+
* - `{ "exists": true }` — pinned to any value. `{ "exists": false }` says what leaving the key
|
|
10184
|
+
* out says.
|
|
10185
|
+
*
|
|
10186
|
+
* Exact values are typed by their condition: a `string` or `select` matches exactly and
|
|
10187
|
+
* case-sensitively, with no trimming; a `location` of format `zipcode` is the postal code
|
|
10188
|
+
* itself, and one of format `zipcode + town` an object carrying both, whose town is compared
|
|
10189
|
+
* case- and whitespace-insensitively while its postal code is not.
|
|
10190
|
+
*
|
|
10191
|
+
* `default`, and any name beginning with `_`, are reserved for the server and cannot be
|
|
10192
|
+
* supplied here.
|
|
10193
|
+
*
|
|
10194
|
+
* example:
|
|
10195
|
+
* {
|
|
10196
|
+
* "postal_code": "46045",
|
|
10197
|
+
* "consumption": {
|
|
10198
|
+
* "lt": 5000
|
|
10199
|
+
* }
|
|
10200
|
+
* }
|
|
10201
|
+
*/
|
|
10202
|
+
ResolveContext;
|
|
10203
|
+
/**
|
|
10204
|
+
* The instant the version is selected at — the version with the latest `valid_from` at or
|
|
10205
|
+
* before it. Defaults to now. A variant whose first version is later than this is
|
|
10206
|
+
* scheduled rather than applicable, and is excluded from resolution entirely.
|
|
10207
|
+
*
|
|
10208
|
+
* An RFC 3339 date (`2026-01-01`, read as midnight UTC) or date-time
|
|
10209
|
+
* (`2026-01-01T00:00:00Z`), to at most millisecond precision. Deliberately not declared as
|
|
10210
|
+
* `format: date-time`, which would reject the plain-date form that this accepts.
|
|
10211
|
+
*
|
|
10212
|
+
* example:
|
|
10213
|
+
* 2027-03-15T00:00:00Z
|
|
10214
|
+
*/
|
|
10215
|
+
as_of?: string;
|
|
10216
|
+
options?: ResolveOptions;
|
|
10217
|
+
}
|
|
10218
|
+
/**
|
|
10219
|
+
* The situation to resolve for: a flat map keyed by condition name, as the entity's schema
|
|
10220
|
+
* declares them. A condition left out of the map is not a wildcard — it matches only variants
|
|
10221
|
+
* that leave that condition unpinned.
|
|
10222
|
+
*
|
|
10223
|
+
* Each value is either an exact value, typed by its condition, or a single-operator predicate
|
|
10224
|
+
* object:
|
|
10225
|
+
*
|
|
10226
|
+
* - `{ "lt": v }`, `{ "lte": v }`, `{ "gt": v }`, `{ "gte": v }` — order against a `number` or
|
|
10227
|
+
* `date` condition.
|
|
10228
|
+
* - `{ "in": [...] }` — membership, against a `string`, `select` or `number` condition.
|
|
10229
|
+
* - `{ "between": "2026-03-01" }` — the explicit spelling of `daterange` containment; a plain
|
|
10230
|
+
* date supplied for a `daterange` condition means the same thing.
|
|
10231
|
+
* - `{ "exists": true }` — pinned to any value. `{ "exists": false }` says what leaving the key
|
|
10232
|
+
* out says.
|
|
10233
|
+
*
|
|
10234
|
+
* Exact values are typed by their condition: a `string` or `select` matches exactly and
|
|
10235
|
+
* case-sensitively, with no trimming; a `location` of format `zipcode` is the postal code
|
|
10236
|
+
* itself, and one of format `zipcode + town` an object carrying both, whose town is compared
|
|
10237
|
+
* case- and whitespace-insensitively while its postal code is not.
|
|
10238
|
+
*
|
|
10239
|
+
* `default`, and any name beginning with `_`, are reserved for the server and cannot be
|
|
10240
|
+
* supplied here.
|
|
10241
|
+
*
|
|
10242
|
+
* example:
|
|
10243
|
+
* {
|
|
10244
|
+
* "postal_code": "46045",
|
|
10245
|
+
* "consumption": {
|
|
10246
|
+
* "lt": 5000
|
|
10247
|
+
* }
|
|
10248
|
+
* }
|
|
10249
|
+
*/
|
|
10250
|
+
export interface ResolveContext {
|
|
10251
|
+
[name: string]: any;
|
|
10252
|
+
}
|
|
10253
|
+
export interface ResolveOptions {
|
|
10254
|
+
/**
|
|
10255
|
+
* Ask for an unambiguous answer. Several applicable variants become `AMBIGUOUS_RESOLUTION`
|
|
10256
|
+
* rather than a set, and nothing applicable becomes `NOT_FOUND` rather than an empty one.
|
|
10257
|
+
* The response shape does not change: `results` simply carries exactly one entry.
|
|
10258
|
+
*
|
|
10259
|
+
*/
|
|
10260
|
+
resolve_one?: boolean;
|
|
10261
|
+
}
|
|
10262
|
+
/**
|
|
10263
|
+
* The entity as this variant leaves it — every attribute of a plain entity read, with the
|
|
10264
|
+
* applicable version's overrides applied — plus the discriminators saying where the numbers
|
|
10265
|
+
* came from.
|
|
10266
|
+
*
|
|
10267
|
+
*/
|
|
10268
|
+
export interface ResolvedVariant {
|
|
10269
|
+
[name: string]: any;
|
|
10270
|
+
/**
|
|
10271
|
+
* The logical entity's id — the same one a plain entity read returns. Resolution never
|
|
10272
|
+
* mints a new identity; a variant is a set of values for *this* entity, not another one.
|
|
10273
|
+
*
|
|
10274
|
+
* example:
|
|
10275
|
+
* price-sp26d1yo
|
|
10276
|
+
*/
|
|
10277
|
+
_id: string;
|
|
10278
|
+
/**
|
|
10279
|
+
* The variant these values came from. Durable: this is what an order or a contract pins to
|
|
10280
|
+
* read the same numbers back later.
|
|
10281
|
+
*
|
|
10282
|
+
* example:
|
|
10283
|
+
* var-46045
|
|
10284
|
+
*/
|
|
10285
|
+
_variant_id: string;
|
|
10286
|
+
/**
|
|
10287
|
+
* The `valid_from` of the version applied for the requested `as_of`.
|
|
10288
|
+
* example:
|
|
10289
|
+
* 2027-01-01T00:00:00.000Z
|
|
10290
|
+
*/
|
|
10291
|
+
_version_valid_from: string;
|
|
10292
|
+
/**
|
|
10293
|
+
* The conditions this variant pins, plus the boolean `default` discriminator.
|
|
10294
|
+
*
|
|
10295
|
+
* Underscore-prefixed, like every other discriminator here, so that it cannot collide with
|
|
10296
|
+
* an attribute an organization happens to have called `conditions`.
|
|
10297
|
+
*
|
|
10298
|
+
* example:
|
|
10299
|
+
* {
|
|
10300
|
+
* "postal_code": "46045",
|
|
10301
|
+
* "default": false
|
|
10302
|
+
* }
|
|
10303
|
+
*/
|
|
10304
|
+
_conditions: {
|
|
10305
|
+
[name: string]: any;
|
|
10306
|
+
default: boolean;
|
|
10307
|
+
};
|
|
10308
|
+
}
|
|
10309
|
+
export interface ResolvedVariants {
|
|
10310
|
+
/**
|
|
10311
|
+
* One composed payload per applicable variant, capped at 100 — a context selecting more
|
|
10312
|
+
* than that is answered with `TOO_MANY_MATCHES` instead, since each result costs its own
|
|
10313
|
+
* version lookup. No dominance or specificity ordering is applied between them.
|
|
10314
|
+
*
|
|
10315
|
+
*/
|
|
10316
|
+
results: /**
|
|
10317
|
+
* The entity as this variant leaves it — every attribute of a plain entity read, with the
|
|
10318
|
+
* applicable version's overrides applied — plus the discriminators saying where the numbers
|
|
10319
|
+
* came from.
|
|
10320
|
+
*
|
|
10321
|
+
*/
|
|
10322
|
+
ResolvedVariant[];
|
|
10323
|
+
}
|
|
10324
|
+
export type SalesTax = "nontaxable" | "reduced" | "standard";
|
|
10325
|
+
export type SaveIntegrationCredentialsParams = /* The auth credentials for external integrations */ IntegrationAuthCredentials;
|
|
10326
|
+
export interface SearchExternalCatalogParams {
|
|
10327
|
+
context: JourneyContext;
|
|
10328
|
+
}
|
|
10329
|
+
export interface SearchExternalCatalogRecommendationsResult {
|
|
10330
|
+
source: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem;
|
|
10331
|
+
offers: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
|
|
10332
|
+
}
|
|
10333
|
+
export interface SearchExternalCatalogResult {
|
|
10334
|
+
/**
|
|
10335
|
+
* The number of results returned.
|
|
10336
|
+
*/
|
|
10337
|
+
hits: number;
|
|
10338
|
+
results: /* An external product & price information (already computed) from an external catalog. */ ExternalCatalogItem[];
|
|
10339
|
+
}
|
|
10340
|
+
/**
|
|
10341
|
+
* A search providers payload
|
|
10342
|
+
*/
|
|
10343
|
+
export interface SearchProvidersParams {
|
|
10344
|
+
/**
|
|
10345
|
+
* The provider type (power or gas)
|
|
10346
|
+
*/
|
|
10347
|
+
type: "power" | "gas";
|
|
10348
|
+
/**
|
|
10349
|
+
* The postal code to search for providers
|
|
10350
|
+
*/
|
|
10351
|
+
postal_code: string;
|
|
10352
|
+
/**
|
|
10353
|
+
* The city to search for providers
|
|
10354
|
+
*/
|
|
10355
|
+
city?: string | null;
|
|
10356
|
+
/**
|
|
10357
|
+
* The street to search for providers
|
|
10358
|
+
*/
|
|
10359
|
+
street?: string | null;
|
|
9656
10360
|
/**
|
|
9657
10361
|
* The street number to search for providers
|
|
9658
10362
|
*/
|
|
@@ -10000,9 +10704,336 @@ declare namespace Components {
|
|
|
10000
10704
|
*/
|
|
10001
10705
|
errors: /* The availability rule error */ ValidateAvailabilityFileError[];
|
|
10002
10706
|
}
|
|
10707
|
+
/**
|
|
10708
|
+
* A variant's pinned conditions as a reader sees them: the pins the schema declares, plus a
|
|
10709
|
+
* boolean `default` saying whether this is the entity's fallback.
|
|
10710
|
+
*
|
|
10711
|
+
* `default` is always present and always a boolean, so a client can branch on "did I get the
|
|
10712
|
+
* fallback?" without knowing how one is stored. The reserved condition a fallback is actually
|
|
10713
|
+
* pinned under never appears here.
|
|
10714
|
+
*
|
|
10715
|
+
* example:
|
|
10716
|
+
* {
|
|
10717
|
+
* "postal_code": "46045",
|
|
10718
|
+
* "default": false
|
|
10719
|
+
* }
|
|
10720
|
+
*/
|
|
10721
|
+
export interface VariantConditions {
|
|
10722
|
+
[name: string]: any;
|
|
10723
|
+
default: boolean;
|
|
10724
|
+
}
|
|
10725
|
+
/**
|
|
10726
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
10727
|
+
*
|
|
10728
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
10729
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
10730
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
10731
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
10732
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
10733
|
+
* variant may override it.
|
|
10734
|
+
*
|
|
10735
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
10736
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
10737
|
+
* then reactivates the same override.
|
|
10738
|
+
*
|
|
10739
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
10740
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
10741
|
+
* set, with no special handling.
|
|
10742
|
+
*
|
|
10743
|
+
* example:
|
|
10744
|
+
* {
|
|
10745
|
+
* "unit_amount": 2499,
|
|
10746
|
+
* "unit_amount_decimal": "24.99"
|
|
10747
|
+
* }
|
|
10748
|
+
*/
|
|
10749
|
+
export interface VariantValues {
|
|
10750
|
+
[name: string]: any;
|
|
10751
|
+
}
|
|
10752
|
+
/**
|
|
10753
|
+
* One version of one variant: the attribute overrides it carries, the instant it takes effect,
|
|
10754
|
+
* and the variant it belongs to.
|
|
10755
|
+
*
|
|
10756
|
+
* These are the version's **own** overrides, not the base entity overlaid with them — this is
|
|
10757
|
+
* what an editing screen loads and saves, and what it edits is the overrides. Composing them onto
|
|
10758
|
+
* the entity is what `:resolve` answers.
|
|
10759
|
+
*
|
|
10760
|
+
*/
|
|
10761
|
+
export interface VariantVersion {
|
|
10762
|
+
/**
|
|
10763
|
+
* example:
|
|
10764
|
+
* var-46045
|
|
10765
|
+
*/
|
|
10766
|
+
variant_id: string;
|
|
10767
|
+
/**
|
|
10768
|
+
* example:
|
|
10769
|
+
* price-sp26d1yo
|
|
10770
|
+
*/
|
|
10771
|
+
entity_id: string;
|
|
10772
|
+
schema: /**
|
|
10773
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
10774
|
+
* conditional-pricing route.
|
|
10775
|
+
*
|
|
10776
|
+
*/
|
|
10777
|
+
ConditionalEntitySlug;
|
|
10778
|
+
/**
|
|
10779
|
+
* The situation the variant applies to, plus the boolean `default` discriminator. A property
|
|
10780
|
+
* of the variant rather than of this version: every version of a variant carries the same
|
|
10781
|
+
* one, and no version write can change it.
|
|
10782
|
+
*
|
|
10783
|
+
* example:
|
|
10784
|
+
* {
|
|
10785
|
+
* "postal_code": "46045",
|
|
10786
|
+
* "default": false
|
|
10787
|
+
* }
|
|
10788
|
+
*/
|
|
10789
|
+
conditions: {
|
|
10790
|
+
[name: string]: any;
|
|
10791
|
+
default: boolean;
|
|
10792
|
+
};
|
|
10793
|
+
/**
|
|
10794
|
+
* When this version takes effect, canonicalized to millisecond-precision UTC. A version's
|
|
10795
|
+
* identity within its variant — it never moves.
|
|
10796
|
+
*
|
|
10797
|
+
* example:
|
|
10798
|
+
* 2027-01-01T00:00:00.000Z
|
|
10799
|
+
*/
|
|
10800
|
+
valid_from: string;
|
|
10801
|
+
values: /**
|
|
10802
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
10803
|
+
*
|
|
10804
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
10805
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
10806
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
10807
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
10808
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
10809
|
+
* variant may override it.
|
|
10810
|
+
*
|
|
10811
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
10812
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
10813
|
+
* then reactivates the same override.
|
|
10814
|
+
*
|
|
10815
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
10816
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
10817
|
+
* set, with no special handling.
|
|
10818
|
+
*
|
|
10819
|
+
* example:
|
|
10820
|
+
* {
|
|
10821
|
+
* "unit_amount": 2499,
|
|
10822
|
+
* "unit_amount_decimal": "24.99"
|
|
10823
|
+
* }
|
|
10824
|
+
*/
|
|
10825
|
+
VariantValues;
|
|
10826
|
+
_created_at?: string;
|
|
10827
|
+
_updated_at?: string;
|
|
10828
|
+
/**
|
|
10829
|
+
* The revision a write to this version must carry to be accepted. Always current: every read
|
|
10830
|
+
* that returns one is strongly consistent, so it is never a marker a write would be refused
|
|
10831
|
+
* for having read too early.
|
|
10832
|
+
*
|
|
10833
|
+
* example:
|
|
10834
|
+
* 3
|
|
10835
|
+
*/
|
|
10836
|
+
_revision?: number;
|
|
10837
|
+
}
|
|
10838
|
+
export interface VariantWriteWarning {
|
|
10839
|
+
/**
|
|
10840
|
+
* - `VARIANT_COUNT_APPROACHING_CAP`: this entity is nearing the number of variants it may
|
|
10841
|
+
* hold. Surfaced rather than rejected, so an importer finds out with a whole run's notice
|
|
10842
|
+
* instead of discovering the limit halfway through a refresh.
|
|
10843
|
+
*
|
|
10844
|
+
*/
|
|
10845
|
+
code: "VARIANT_COUNT_APPROACHING_CAP";
|
|
10846
|
+
message: string;
|
|
10847
|
+
/**
|
|
10848
|
+
* Variants this entity holds, including the one just created.
|
|
10849
|
+
*/
|
|
10850
|
+
variant_count?: number;
|
|
10851
|
+
/**
|
|
10852
|
+
* Variants this entity may hold. Configurable per organization.
|
|
10853
|
+
*/
|
|
10854
|
+
cap?: number;
|
|
10855
|
+
}
|
|
10856
|
+
/**
|
|
10857
|
+
* Something a version write moved. A version write is never refused for being late — backdating a
|
|
10858
|
+
* version, and editing or deleting one that has already been superseded, are both accepted — so
|
|
10859
|
+
* what a caller gets instead is a warning naming exactly what changed. One write can carry both
|
|
10860
|
+
* codes.
|
|
10861
|
+
*
|
|
10862
|
+
*/
|
|
10863
|
+
export interface VersionWriteWarning {
|
|
10864
|
+
/**
|
|
10865
|
+
* - `ACTIVE_VERSION_REPLACED`: what resolves **now** changed, other than by a newer version
|
|
10866
|
+
* taking effect. The version in effect was written behind, or removed.
|
|
10867
|
+
* - `SUPERSEDED_VERSION_WRITTEN`: what a past-dated (`as_of`) read returns changed. The write
|
|
10868
|
+
* landed on, or created, a version that is not the one currently in effect.
|
|
10869
|
+
*
|
|
10870
|
+
*/
|
|
10871
|
+
code: "ACTIVE_VERSION_REPLACED" | "SUPERSEDED_VERSION_WRITTEN";
|
|
10872
|
+
message: string;
|
|
10873
|
+
/**
|
|
10874
|
+
* The version this write created, changed or removed.
|
|
10875
|
+
* example:
|
|
10876
|
+
* 2026-08-01T00:00:00.000Z
|
|
10877
|
+
*/
|
|
10878
|
+
valid_from: string;
|
|
10879
|
+
/**
|
|
10880
|
+
* The version in effect when the write landed, before it did. Absent when the variant had
|
|
10881
|
+
* none — every version of it still scheduled.
|
|
10882
|
+
*
|
|
10883
|
+
* example:
|
|
10884
|
+
* 2026-01-01T00:00:00.000Z
|
|
10885
|
+
*/
|
|
10886
|
+
active_valid_from?: string;
|
|
10887
|
+
}
|
|
10888
|
+
/**
|
|
10889
|
+
* A version as a write left it, together with anything the write moved.
|
|
10890
|
+
*
|
|
10891
|
+
*/
|
|
10892
|
+
export interface WrittenVariantVersion {
|
|
10893
|
+
/**
|
|
10894
|
+
* example:
|
|
10895
|
+
* var-46045
|
|
10896
|
+
*/
|
|
10897
|
+
variant_id: string;
|
|
10898
|
+
/**
|
|
10899
|
+
* example:
|
|
10900
|
+
* price-sp26d1yo
|
|
10901
|
+
*/
|
|
10902
|
+
entity_id: string;
|
|
10903
|
+
schema: /**
|
|
10904
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
10905
|
+
* conditional-pricing route.
|
|
10906
|
+
*
|
|
10907
|
+
*/
|
|
10908
|
+
ConditionalEntitySlug;
|
|
10909
|
+
/**
|
|
10910
|
+
* The situation the variant applies to, plus the boolean `default` discriminator. A property
|
|
10911
|
+
* of the variant rather than of this version: every version of a variant carries the same
|
|
10912
|
+
* one, and no version write can change it.
|
|
10913
|
+
*
|
|
10914
|
+
* example:
|
|
10915
|
+
* {
|
|
10916
|
+
* "postal_code": "46045",
|
|
10917
|
+
* "default": false
|
|
10918
|
+
* }
|
|
10919
|
+
*/
|
|
10920
|
+
conditions: {
|
|
10921
|
+
[name: string]: any;
|
|
10922
|
+
default: boolean;
|
|
10923
|
+
};
|
|
10924
|
+
/**
|
|
10925
|
+
* When this version takes effect, canonicalized to millisecond-precision UTC. A version's
|
|
10926
|
+
* identity within its variant — it never moves.
|
|
10927
|
+
*
|
|
10928
|
+
* example:
|
|
10929
|
+
* 2027-01-01T00:00:00.000Z
|
|
10930
|
+
*/
|
|
10931
|
+
valid_from: string;
|
|
10932
|
+
values: /**
|
|
10933
|
+
* The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
10934
|
+
*
|
|
10935
|
+
* Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
10936
|
+
* (anything underscore-prefixed), readonly attributes, hidden attributes and non-overridable
|
|
10937
|
+
* attributes present here are ignored rather than rejected, so a client working from a slightly
|
|
10938
|
+
* stale schema snapshot still succeeds instead of failing on fields it could not have known to
|
|
10939
|
+
* drop. An attribute's `render_condition` says when to show it and has no bearing on whether a
|
|
10940
|
+
* variant may override it.
|
|
10941
|
+
*
|
|
10942
|
+
* Ignored means *not updated*, never *removed*: a value already stored for an attribute that is
|
|
10943
|
+
* not currently overridable is preserved, so removing and restoring the flag deactivates and
|
|
10944
|
+
* then reactivates the same override.
|
|
10945
|
+
*
|
|
10946
|
+
* A composite price's `price_components` is an ordinary overridable relation attribute: a
|
|
10947
|
+
* composite variant pins its component variants here the same way any other relation value is
|
|
10948
|
+
* set, with no special handling.
|
|
10949
|
+
*
|
|
10950
|
+
* example:
|
|
10951
|
+
* {
|
|
10952
|
+
* "unit_amount": 2499,
|
|
10953
|
+
* "unit_amount_decimal": "24.99"
|
|
10954
|
+
* }
|
|
10955
|
+
*/
|
|
10956
|
+
VariantValues;
|
|
10957
|
+
_created_at?: string;
|
|
10958
|
+
_updated_at?: string;
|
|
10959
|
+
/**
|
|
10960
|
+
* The revision a write to this version must carry to be accepted. Always current: every read
|
|
10961
|
+
* that returns one is strongly consistent, so it is never a marker a write would be refused
|
|
10962
|
+
* for having read too early.
|
|
10963
|
+
*
|
|
10964
|
+
* example:
|
|
10965
|
+
* 3
|
|
10966
|
+
*/
|
|
10967
|
+
_revision?: number;
|
|
10968
|
+
/**
|
|
10969
|
+
* What this write moved, if anything. Empty in the ordinary case — a client reads its
|
|
10970
|
+
* length rather than branching on its absence.
|
|
10971
|
+
*
|
|
10972
|
+
*/
|
|
10973
|
+
warnings: /**
|
|
10974
|
+
* Something a version write moved. A version write is never refused for being late — backdating a
|
|
10975
|
+
* version, and editing or deleting one that has already been superseded, are both accepted — so
|
|
10976
|
+
* what a caller gets instead is a warning naming exactly what changed. One write can carry both
|
|
10977
|
+
* codes.
|
|
10978
|
+
*
|
|
10979
|
+
*/
|
|
10980
|
+
VersionWriteWarning[];
|
|
10981
|
+
}
|
|
10003
10982
|
}
|
|
10004
10983
|
}
|
|
10005
10984
|
declare namespace Paths {
|
|
10985
|
+
namespace $AppendConditionalVariantVersion {
|
|
10986
|
+
namespace Parameters {
|
|
10987
|
+
export type EntityId = string;
|
|
10988
|
+
export type Slug = /**
|
|
10989
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
10990
|
+
* conditional-pricing route.
|
|
10991
|
+
*
|
|
10992
|
+
*/
|
|
10993
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
10994
|
+
export type VariantId = string;
|
|
10995
|
+
}
|
|
10996
|
+
export interface PathParameters {
|
|
10997
|
+
slug: Parameters.Slug;
|
|
10998
|
+
entity_id: Parameters.EntityId;
|
|
10999
|
+
variant_id: Parameters.VariantId;
|
|
11000
|
+
}
|
|
11001
|
+
export type RequestBody = Components.Schemas.AppendVersionRequest;
|
|
11002
|
+
namespace Responses {
|
|
11003
|
+
export type $201 = /**
|
|
11004
|
+
* A version as a write left it, together with anything the write moved.
|
|
11005
|
+
*
|
|
11006
|
+
*/
|
|
11007
|
+
Components.Schemas.WrittenVariantVersion;
|
|
11008
|
+
export type $400 = /**
|
|
11009
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11010
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11011
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11012
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11013
|
+
* keeps the plain `Error` shape.
|
|
11014
|
+
*
|
|
11015
|
+
*/
|
|
11016
|
+
Components.Schemas.ConditionalPricingError;
|
|
11017
|
+
export type $404 = /**
|
|
11018
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11019
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11020
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11021
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11022
|
+
* keeps the plain `Error` shape.
|
|
11023
|
+
*
|
|
11024
|
+
*/
|
|
11025
|
+
Components.Schemas.ConditionalPricingError;
|
|
11026
|
+
export type $409 = /**
|
|
11027
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11028
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11029
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11030
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11031
|
+
* keeps the plain `Error` shape.
|
|
11032
|
+
*
|
|
11033
|
+
*/
|
|
11034
|
+
Components.Schemas.ConditionalPricingError;
|
|
11035
|
+
}
|
|
11036
|
+
}
|
|
10006
11037
|
namespace $AvailabilityCheck {
|
|
10007
11038
|
export interface HeaderParameters {
|
|
10008
11039
|
"X-Ivy-Org-ID": Parameters.XIvyOrgID;
|
|
@@ -10093,6 +11124,152 @@ declare namespace Paths {
|
|
|
10093
11124
|
export type $403 = Components.Schemas.Error;
|
|
10094
11125
|
}
|
|
10095
11126
|
}
|
|
11127
|
+
namespace $CreateConditionalVariant {
|
|
11128
|
+
namespace Parameters {
|
|
11129
|
+
export type EntityId = string;
|
|
11130
|
+
export type Slug = /**
|
|
11131
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11132
|
+
* conditional-pricing route.
|
|
11133
|
+
*
|
|
11134
|
+
*/
|
|
11135
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11136
|
+
}
|
|
11137
|
+
export interface PathParameters {
|
|
11138
|
+
slug: Parameters.Slug;
|
|
11139
|
+
entity_id: Parameters.EntityId;
|
|
11140
|
+
}
|
|
11141
|
+
export type RequestBody = Components.Schemas.CreateVariantRequest;
|
|
11142
|
+
namespace Responses {
|
|
11143
|
+
export type $201 = Components.Schemas.CreatedVariant;
|
|
11144
|
+
export type $400 = /**
|
|
11145
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11146
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11147
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11148
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11149
|
+
* keeps the plain `Error` shape.
|
|
11150
|
+
*
|
|
11151
|
+
*/
|
|
11152
|
+
Components.Schemas.ConditionalPricingError;
|
|
11153
|
+
export type $404 = /**
|
|
11154
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11155
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11156
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11157
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11158
|
+
* keeps the plain `Error` shape.
|
|
11159
|
+
*
|
|
11160
|
+
*/
|
|
11161
|
+
Components.Schemas.ConditionalPricingError;
|
|
11162
|
+
export type $409 = /**
|
|
11163
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11164
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11165
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11166
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11167
|
+
* keeps the plain `Error` shape.
|
|
11168
|
+
*
|
|
11169
|
+
*/
|
|
11170
|
+
Components.Schemas.ConditionalPricingError;
|
|
11171
|
+
}
|
|
11172
|
+
}
|
|
11173
|
+
namespace $DeleteConditionalVariant {
|
|
11174
|
+
namespace Parameters {
|
|
11175
|
+
export type EntityId = string;
|
|
11176
|
+
export type Slug = /**
|
|
11177
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11178
|
+
* conditional-pricing route.
|
|
11179
|
+
*
|
|
11180
|
+
*/
|
|
11181
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11182
|
+
export type VariantId = string;
|
|
11183
|
+
}
|
|
11184
|
+
export interface PathParameters {
|
|
11185
|
+
slug: Parameters.Slug;
|
|
11186
|
+
entity_id: Parameters.EntityId;
|
|
11187
|
+
variant_id: Parameters.VariantId;
|
|
11188
|
+
}
|
|
11189
|
+
namespace Responses {
|
|
11190
|
+
export type $200 = Components.Schemas.DeletedVariant;
|
|
11191
|
+
export type $400 = /**
|
|
11192
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11193
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11194
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11195
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11196
|
+
* keeps the plain `Error` shape.
|
|
11197
|
+
*
|
|
11198
|
+
*/
|
|
11199
|
+
Components.Schemas.ConditionalPricingError;
|
|
11200
|
+
export type $404 = /**
|
|
11201
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11202
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11203
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11204
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11205
|
+
* keeps the plain `Error` shape.
|
|
11206
|
+
*
|
|
11207
|
+
*/
|
|
11208
|
+
Components.Schemas.ConditionalPricingError;
|
|
11209
|
+
export type $409 = /**
|
|
11210
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11211
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11212
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11213
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11214
|
+
* keeps the plain `Error` shape.
|
|
11215
|
+
*
|
|
11216
|
+
*/
|
|
11217
|
+
Components.Schemas.ConditionalPricingError;
|
|
11218
|
+
}
|
|
11219
|
+
}
|
|
11220
|
+
namespace $DeleteConditionalVariantVersion {
|
|
11221
|
+
namespace Parameters {
|
|
11222
|
+
export type EntityId = string;
|
|
11223
|
+
export type Revision = number;
|
|
11224
|
+
export type Slug = /**
|
|
11225
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11226
|
+
* conditional-pricing route.
|
|
11227
|
+
*
|
|
11228
|
+
*/
|
|
11229
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11230
|
+
export type ValidFrom = string;
|
|
11231
|
+
export type VariantId = string;
|
|
11232
|
+
}
|
|
11233
|
+
export interface PathParameters {
|
|
11234
|
+
slug: Parameters.Slug;
|
|
11235
|
+
entity_id: Parameters.EntityId;
|
|
11236
|
+
variant_id: Parameters.VariantId;
|
|
11237
|
+
valid_from: Parameters.ValidFrom;
|
|
11238
|
+
}
|
|
11239
|
+
export interface QueryParameters {
|
|
11240
|
+
_revision: Parameters.Revision;
|
|
11241
|
+
}
|
|
11242
|
+
namespace Responses {
|
|
11243
|
+
export type $200 = Components.Schemas.DeletedVariantVersion;
|
|
11244
|
+
export type $400 = /**
|
|
11245
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11246
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11247
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11248
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11249
|
+
* keeps the plain `Error` shape.
|
|
11250
|
+
*
|
|
11251
|
+
*/
|
|
11252
|
+
Components.Schemas.ConditionalPricingError;
|
|
11253
|
+
export type $404 = /**
|
|
11254
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11255
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11256
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11257
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11258
|
+
* keeps the plain `Error` shape.
|
|
11259
|
+
*
|
|
11260
|
+
*/
|
|
11261
|
+
Components.Schemas.ConditionalPricingError;
|
|
11262
|
+
export type $409 = /**
|
|
11263
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11264
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11265
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11266
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11267
|
+
* keeps the plain `Error` shape.
|
|
11268
|
+
*
|
|
11269
|
+
*/
|
|
11270
|
+
Components.Schemas.ConditionalPricingError;
|
|
11271
|
+
}
|
|
11272
|
+
}
|
|
10096
11273
|
namespace $DeleteCredentials {
|
|
10097
11274
|
namespace Parameters {
|
|
10098
11275
|
export type IntegrationId = Components.Schemas.IntegrationId;
|
|
@@ -10106,6 +11283,119 @@ declare namespace Paths {
|
|
|
10106
11283
|
export type $400 = Components.Schemas.Error;
|
|
10107
11284
|
}
|
|
10108
11285
|
}
|
|
11286
|
+
namespace $GetActiveConditionalVariantVersion {
|
|
11287
|
+
namespace Parameters {
|
|
11288
|
+
export type EntityId = string;
|
|
11289
|
+
export type Slug = /**
|
|
11290
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11291
|
+
* conditional-pricing route.
|
|
11292
|
+
*
|
|
11293
|
+
*/
|
|
11294
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11295
|
+
export type VariantId = string;
|
|
11296
|
+
}
|
|
11297
|
+
export interface PathParameters {
|
|
11298
|
+
slug: Parameters.Slug;
|
|
11299
|
+
entity_id: Parameters.EntityId;
|
|
11300
|
+
variant_id: Parameters.VariantId;
|
|
11301
|
+
}
|
|
11302
|
+
namespace Responses {
|
|
11303
|
+
export type $200 = /**
|
|
11304
|
+
* One version of one variant: the attribute overrides it carries, the instant it takes effect,
|
|
11305
|
+
* and the variant it belongs to.
|
|
11306
|
+
*
|
|
11307
|
+
* These are the version's **own** overrides, not the base entity overlaid with them — this is
|
|
11308
|
+
* what an editing screen loads and saves, and what it edits is the overrides. Composing them onto
|
|
11309
|
+
* the entity is what `:resolve` answers.
|
|
11310
|
+
*
|
|
11311
|
+
*/
|
|
11312
|
+
Components.Schemas.VariantVersion;
|
|
11313
|
+
export type $400 = /**
|
|
11314
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11315
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11316
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11317
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11318
|
+
* keeps the plain `Error` shape.
|
|
11319
|
+
*
|
|
11320
|
+
*/
|
|
11321
|
+
Components.Schemas.ConditionalPricingError;
|
|
11322
|
+
export type $404 = /**
|
|
11323
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11324
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11325
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11326
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11327
|
+
* keeps the plain `Error` shape.
|
|
11328
|
+
*
|
|
11329
|
+
*/
|
|
11330
|
+
Components.Schemas.ConditionalPricingError;
|
|
11331
|
+
}
|
|
11332
|
+
}
|
|
11333
|
+
namespace $GetConditionSets {
|
|
11334
|
+
namespace Parameters {
|
|
11335
|
+
export type Slug = /**
|
|
11336
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11337
|
+
* conditional-pricing route.
|
|
11338
|
+
*
|
|
11339
|
+
*/
|
|
11340
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11341
|
+
}
|
|
11342
|
+
export interface PathParameters {
|
|
11343
|
+
slug: Parameters.Slug;
|
|
11344
|
+
}
|
|
11345
|
+
namespace Responses {
|
|
11346
|
+
export type $200 = Components.Schemas.ConditionSetCatalog;
|
|
11347
|
+
export type $400 = Components.Schemas.Error;
|
|
11348
|
+
}
|
|
11349
|
+
}
|
|
11350
|
+
namespace $GetConditionalVariantVersion {
|
|
11351
|
+
namespace Parameters {
|
|
11352
|
+
export type EntityId = string;
|
|
11353
|
+
export type Slug = /**
|
|
11354
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11355
|
+
* conditional-pricing route.
|
|
11356
|
+
*
|
|
11357
|
+
*/
|
|
11358
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11359
|
+
export type ValidFrom = string;
|
|
11360
|
+
export type VariantId = string;
|
|
11361
|
+
}
|
|
11362
|
+
export interface PathParameters {
|
|
11363
|
+
slug: Parameters.Slug;
|
|
11364
|
+
entity_id: Parameters.EntityId;
|
|
11365
|
+
variant_id: Parameters.VariantId;
|
|
11366
|
+
valid_from: Parameters.ValidFrom;
|
|
11367
|
+
}
|
|
11368
|
+
namespace Responses {
|
|
11369
|
+
export type $200 = /**
|
|
11370
|
+
* One version of one variant: the attribute overrides it carries, the instant it takes effect,
|
|
11371
|
+
* and the variant it belongs to.
|
|
11372
|
+
*
|
|
11373
|
+
* These are the version's **own** overrides, not the base entity overlaid with them — this is
|
|
11374
|
+
* what an editing screen loads and saves, and what it edits is the overrides. Composing them onto
|
|
11375
|
+
* the entity is what `:resolve` answers.
|
|
11376
|
+
*
|
|
11377
|
+
*/
|
|
11378
|
+
Components.Schemas.VariantVersion;
|
|
11379
|
+
export type $400 = /**
|
|
11380
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11381
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11382
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11383
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11384
|
+
* keeps the plain `Error` shape.
|
|
11385
|
+
*
|
|
11386
|
+
*/
|
|
11387
|
+
Components.Schemas.ConditionalPricingError;
|
|
11388
|
+
export type $404 = /**
|
|
11389
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11390
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11391
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11392
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11393
|
+
* keeps the plain `Error` shape.
|
|
11394
|
+
*
|
|
11395
|
+
*/
|
|
11396
|
+
Components.Schemas.ConditionalPricingError;
|
|
11397
|
+
}
|
|
11398
|
+
}
|
|
10109
11399
|
namespace $GetCredentials {
|
|
10110
11400
|
namespace Parameters {
|
|
10111
11401
|
export type IntegrationId = Components.Schemas.IntegrationId;
|
|
@@ -10252,6 +11542,112 @@ declare namespace Paths {
|
|
|
10252
11542
|
export type $404 = Components.Schemas.Error;
|
|
10253
11543
|
}
|
|
10254
11544
|
}
|
|
11545
|
+
namespace $PatchActiveConditionalVariantVersion {
|
|
11546
|
+
namespace Parameters {
|
|
11547
|
+
export type EntityId = string;
|
|
11548
|
+
export type Slug = /**
|
|
11549
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11550
|
+
* conditional-pricing route.
|
|
11551
|
+
*
|
|
11552
|
+
*/
|
|
11553
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11554
|
+
export type VariantId = string;
|
|
11555
|
+
}
|
|
11556
|
+
export interface PathParameters {
|
|
11557
|
+
slug: Parameters.Slug;
|
|
11558
|
+
entity_id: Parameters.EntityId;
|
|
11559
|
+
variant_id: Parameters.VariantId;
|
|
11560
|
+
}
|
|
11561
|
+
export type RequestBody = Components.Schemas.PatchVersionRequest;
|
|
11562
|
+
namespace Responses {
|
|
11563
|
+
export type $200 = /**
|
|
11564
|
+
* A version as a write left it, together with anything the write moved.
|
|
11565
|
+
*
|
|
11566
|
+
*/
|
|
11567
|
+
Components.Schemas.WrittenVariantVersion;
|
|
11568
|
+
export type $400 = /**
|
|
11569
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11570
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11571
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11572
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11573
|
+
* keeps the plain `Error` shape.
|
|
11574
|
+
*
|
|
11575
|
+
*/
|
|
11576
|
+
Components.Schemas.ConditionalPricingError;
|
|
11577
|
+
export type $404 = /**
|
|
11578
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11579
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11580
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11581
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11582
|
+
* keeps the plain `Error` shape.
|
|
11583
|
+
*
|
|
11584
|
+
*/
|
|
11585
|
+
Components.Schemas.ConditionalPricingError;
|
|
11586
|
+
export type $409 = /**
|
|
11587
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11588
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11589
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11590
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11591
|
+
* keeps the plain `Error` shape.
|
|
11592
|
+
*
|
|
11593
|
+
*/
|
|
11594
|
+
Components.Schemas.ConditionalPricingError;
|
|
11595
|
+
}
|
|
11596
|
+
}
|
|
11597
|
+
namespace $PatchConditionalVariantVersion {
|
|
11598
|
+
namespace Parameters {
|
|
11599
|
+
export type EntityId = string;
|
|
11600
|
+
export type Slug = /**
|
|
11601
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11602
|
+
* conditional-pricing route.
|
|
11603
|
+
*
|
|
11604
|
+
*/
|
|
11605
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11606
|
+
export type ValidFrom = string;
|
|
11607
|
+
export type VariantId = string;
|
|
11608
|
+
}
|
|
11609
|
+
export interface PathParameters {
|
|
11610
|
+
slug: Parameters.Slug;
|
|
11611
|
+
entity_id: Parameters.EntityId;
|
|
11612
|
+
variant_id: Parameters.VariantId;
|
|
11613
|
+
valid_from: Parameters.ValidFrom;
|
|
11614
|
+
}
|
|
11615
|
+
export type RequestBody = Components.Schemas.PatchVersionRequest;
|
|
11616
|
+
namespace Responses {
|
|
11617
|
+
export type $200 = /**
|
|
11618
|
+
* A version as a write left it, together with anything the write moved.
|
|
11619
|
+
*
|
|
11620
|
+
*/
|
|
11621
|
+
Components.Schemas.WrittenVariantVersion;
|
|
11622
|
+
export type $400 = /**
|
|
11623
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11624
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11625
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11626
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11627
|
+
* keeps the plain `Error` shape.
|
|
11628
|
+
*
|
|
11629
|
+
*/
|
|
11630
|
+
Components.Schemas.ConditionalPricingError;
|
|
11631
|
+
export type $404 = /**
|
|
11632
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11633
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11634
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11635
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11636
|
+
* keeps the plain `Error` shape.
|
|
11637
|
+
*
|
|
11638
|
+
*/
|
|
11639
|
+
Components.Schemas.ConditionalPricingError;
|
|
11640
|
+
export type $409 = /**
|
|
11641
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11642
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11643
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11644
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11645
|
+
* keeps the plain `Error` shape.
|
|
11646
|
+
*
|
|
11647
|
+
*/
|
|
11648
|
+
Components.Schemas.ConditionalPricingError;
|
|
11649
|
+
}
|
|
11650
|
+
}
|
|
10255
11651
|
namespace $PrivateSearchCatalog {
|
|
10256
11652
|
export type RequestBody = /**
|
|
10257
11653
|
* A catalog search payload
|
|
@@ -10282,21 +11678,160 @@ declare namespace Paths {
|
|
|
10282
11678
|
* ]
|
|
10283
11679
|
* }
|
|
10284
11680
|
*/
|
|
10285
|
-
Components.Schemas.CatalogSearchResult;
|
|
10286
|
-
export type $400 = Components.Schemas.Error;
|
|
11681
|
+
Components.Schemas.CatalogSearchResult;
|
|
11682
|
+
export type $400 = Components.Schemas.Error;
|
|
11683
|
+
}
|
|
11684
|
+
}
|
|
11685
|
+
namespace $ProductRecommendations {
|
|
11686
|
+
export interface HeaderParameters {
|
|
11687
|
+
"X-Ivy-Org-ID"?: Parameters.XIvyOrgID;
|
|
11688
|
+
}
|
|
11689
|
+
namespace Parameters {
|
|
11690
|
+
export type XIvyOrgID = string;
|
|
11691
|
+
}
|
|
11692
|
+
export type RequestBody = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationSearch;
|
|
11693
|
+
namespace Responses {
|
|
11694
|
+
export type $200 = /* Product recommendations request payload */ Components.Schemas.ProductRecommendationResponse;
|
|
11695
|
+
export type $400 = Components.Schemas.Error;
|
|
11696
|
+
}
|
|
11697
|
+
}
|
|
11698
|
+
namespace $ReplaceActiveConditionalVariantVersion {
|
|
11699
|
+
namespace Parameters {
|
|
11700
|
+
export type EntityId = string;
|
|
11701
|
+
export type Slug = /**
|
|
11702
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11703
|
+
* conditional-pricing route.
|
|
11704
|
+
*
|
|
11705
|
+
*/
|
|
11706
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11707
|
+
export type VariantId = string;
|
|
11708
|
+
}
|
|
11709
|
+
export interface PathParameters {
|
|
11710
|
+
slug: Parameters.Slug;
|
|
11711
|
+
entity_id: Parameters.EntityId;
|
|
11712
|
+
variant_id: Parameters.VariantId;
|
|
11713
|
+
}
|
|
11714
|
+
export type RequestBody = Components.Schemas.ReplaceVersionRequest;
|
|
11715
|
+
namespace Responses {
|
|
11716
|
+
export type $200 = /**
|
|
11717
|
+
* A version as a write left it, together with anything the write moved.
|
|
11718
|
+
*
|
|
11719
|
+
*/
|
|
11720
|
+
Components.Schemas.WrittenVariantVersion;
|
|
11721
|
+
export type $400 = /**
|
|
11722
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11723
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11724
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11725
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11726
|
+
* keeps the plain `Error` shape.
|
|
11727
|
+
*
|
|
11728
|
+
*/
|
|
11729
|
+
Components.Schemas.ConditionalPricingError;
|
|
11730
|
+
export type $404 = /**
|
|
11731
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11732
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11733
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11734
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11735
|
+
* keeps the plain `Error` shape.
|
|
11736
|
+
*
|
|
11737
|
+
*/
|
|
11738
|
+
Components.Schemas.ConditionalPricingError;
|
|
11739
|
+
export type $409 = /**
|
|
11740
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11741
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11742
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11743
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11744
|
+
* keeps the plain `Error` shape.
|
|
11745
|
+
*
|
|
11746
|
+
*/
|
|
11747
|
+
Components.Schemas.ConditionalPricingError;
|
|
10287
11748
|
}
|
|
10288
11749
|
}
|
|
10289
|
-
namespace $
|
|
10290
|
-
export interface HeaderParameters {
|
|
10291
|
-
"X-Ivy-Org-ID"?: Parameters.XIvyOrgID;
|
|
10292
|
-
}
|
|
11750
|
+
namespace $ReplaceConditionalVariantVersion {
|
|
10293
11751
|
namespace Parameters {
|
|
10294
|
-
export type
|
|
11752
|
+
export type EntityId = string;
|
|
11753
|
+
export type Slug = /**
|
|
11754
|
+
* Schema slug of an entity type that can be conditional — the `{slug}` of every
|
|
11755
|
+
* conditional-pricing route.
|
|
11756
|
+
*
|
|
11757
|
+
*/
|
|
11758
|
+
Components.Schemas.ConditionalEntitySlug;
|
|
11759
|
+
export type ValidFrom = string;
|
|
11760
|
+
export type VariantId = string;
|
|
10295
11761
|
}
|
|
10296
|
-
export
|
|
11762
|
+
export interface PathParameters {
|
|
11763
|
+
slug: Parameters.Slug;
|
|
11764
|
+
entity_id: Parameters.EntityId;
|
|
11765
|
+
variant_id: Parameters.VariantId;
|
|
11766
|
+
valid_from: Parameters.ValidFrom;
|
|
11767
|
+
}
|
|
11768
|
+
export type RequestBody = Components.Schemas.ReplaceVersionRequest;
|
|
10297
11769
|
namespace Responses {
|
|
10298
|
-
export type $200 =
|
|
10299
|
-
|
|
11770
|
+
export type $200 = /**
|
|
11771
|
+
* A version as a write left it, together with anything the write moved.
|
|
11772
|
+
*
|
|
11773
|
+
*/
|
|
11774
|
+
Components.Schemas.WrittenVariantVersion;
|
|
11775
|
+
export type $400 = /**
|
|
11776
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11777
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11778
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11779
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11780
|
+
* keeps the plain `Error` shape.
|
|
11781
|
+
*
|
|
11782
|
+
*/
|
|
11783
|
+
Components.Schemas.ConditionalPricingError;
|
|
11784
|
+
export type $404 = /**
|
|
11785
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11786
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11787
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11788
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11789
|
+
* keeps the plain `Error` shape.
|
|
11790
|
+
*
|
|
11791
|
+
*/
|
|
11792
|
+
Components.Schemas.ConditionalPricingError;
|
|
11793
|
+
export type $409 = /**
|
|
11794
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11795
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11796
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11797
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11798
|
+
* keeps the plain `Error` shape.
|
|
11799
|
+
*
|
|
11800
|
+
*/
|
|
11801
|
+
Components.Schemas.ConditionalPricingError;
|
|
11802
|
+
}
|
|
11803
|
+
}
|
|
11804
|
+
namespace $ResolveConditionalEntity {
|
|
11805
|
+
export type RequestBody = Components.Schemas.ResolveConditionalEntityRequest;
|
|
11806
|
+
namespace Responses {
|
|
11807
|
+
export type $200 = Components.Schemas.ResolvedVariants;
|
|
11808
|
+
export type $400 = /**
|
|
11809
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11810
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11811
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11812
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11813
|
+
* keeps the plain `Error` shape.
|
|
11814
|
+
*
|
|
11815
|
+
*/
|
|
11816
|
+
Components.Schemas.ConditionalPricingError;
|
|
11817
|
+
export type $404 = /**
|
|
11818
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11819
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11820
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11821
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11822
|
+
* keeps the plain `Error` shape.
|
|
11823
|
+
*
|
|
11824
|
+
*/
|
|
11825
|
+
Components.Schemas.ConditionalPricingError;
|
|
11826
|
+
export type $409 = /**
|
|
11827
|
+
* An error from a conditional-pricing operation, carrying a machine-readable `code`
|
|
11828
|
+
* from the conditional-pricing vocabulary plus any structured data about the failure,
|
|
11829
|
+
* so a client can branch on the kind of failure rather than parse the message.
|
|
11830
|
+
* Referenced only by the operations that emit these codes; every other operation
|
|
11831
|
+
* keeps the plain `Error` shape.
|
|
11832
|
+
*
|
|
11833
|
+
*/
|
|
11834
|
+
Components.Schemas.ConditionalPricingError;
|
|
10300
11835
|
}
|
|
10301
11836
|
}
|
|
10302
11837
|
namespace $SaveCredentials {
|
|
@@ -11036,7 +12571,7 @@ declare namespace Paths {
|
|
|
11036
12571
|
}
|
|
11037
12572
|
namespace PutOrder {
|
|
11038
12573
|
namespace Parameters {
|
|
11039
|
-
export type Id =
|
|
12574
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
11040
12575
|
}
|
|
11041
12576
|
export interface PathParameters {
|
|
11042
12577
|
id: Parameters.Id;
|
|
@@ -11613,7 +13148,7 @@ declare namespace Paths {
|
|
|
11613
13148
|
|
|
11614
13149
|
interface OperationMethods {
|
|
11615
13150
|
/**
|
|
11616
|
-
* $calculatePricingDetails - calculatePricingDetails
|
|
13151
|
+
* $calculatePricingDetails - $calculatePricingDetails
|
|
11617
13152
|
*
|
|
11618
13153
|
* Computes a set of pricing details that can be persisted on an entity with the pricing capability enabled, e.g: Orders or Contracts.
|
|
11619
13154
|
*/
|
|
@@ -11643,7 +13178,7 @@ interface OperationMethods {
|
|
|
11643
13178
|
config?: AxiosRequestConfig
|
|
11644
13179
|
): OperationResponse<Paths.PutOrder.Responses.$200>
|
|
11645
13180
|
/**
|
|
11646
|
-
* $checkoutCart - checkoutCart
|
|
13181
|
+
* $checkoutCart - $checkoutCart
|
|
11647
13182
|
*
|
|
11648
13183
|
* Checkouts a cart and executes the specified checkout `mode` process.
|
|
11649
13184
|
*
|
|
@@ -11664,7 +13199,7 @@ interface OperationMethods {
|
|
|
11664
13199
|
config?: AxiosRequestConfig
|
|
11665
13200
|
): OperationResponse<Paths.$CheckoutCart.Responses.$200>
|
|
11666
13201
|
/**
|
|
11667
|
-
* $searchCatalog - searchCatalog
|
|
13202
|
+
* $searchCatalog - $searchCatalog
|
|
11668
13203
|
*
|
|
11669
13204
|
* Provides a querying functionalities over products and prices of the Catalog for a given organization.
|
|
11670
13205
|
*/
|
|
@@ -11674,7 +13209,7 @@ interface OperationMethods {
|
|
|
11674
13209
|
config?: AxiosRequestConfig
|
|
11675
13210
|
): OperationResponse<Paths.$SearchCatalog.Responses.$200>
|
|
11676
13211
|
/**
|
|
11677
|
-
* $privateSearchCatalog - privateSearchCatalog
|
|
13212
|
+
* $privateSearchCatalog - $privateSearchCatalog
|
|
11678
13213
|
*
|
|
11679
13214
|
* Provides a querying functionalities over products and prices of the Catalog for a given organization.
|
|
11680
13215
|
*/
|
|
@@ -11684,7 +13219,7 @@ interface OperationMethods {
|
|
|
11684
13219
|
config?: AxiosRequestConfig
|
|
11685
13220
|
): OperationResponse<Paths.$PrivateSearchCatalog.Responses.$200>
|
|
11686
13221
|
/**
|
|
11687
|
-
* $validatePromoCodes - validatePromoCodes
|
|
13222
|
+
* $validatePromoCodes - $validatePromoCodes
|
|
11688
13223
|
*
|
|
11689
13224
|
* Validate a list of promo codes against a list of coupons
|
|
11690
13225
|
*/
|
|
@@ -11694,7 +13229,7 @@ interface OperationMethods {
|
|
|
11694
13229
|
config?: AxiosRequestConfig
|
|
11695
13230
|
): OperationResponse<Paths.$ValidatePromoCodes.Responses.$200>
|
|
11696
13231
|
/**
|
|
11697
|
-
* $availabilityCheck - availabilityCheck
|
|
13232
|
+
* $availabilityCheck - $availabilityCheck
|
|
11698
13233
|
*
|
|
11699
13234
|
* The availability check endpoint
|
|
11700
13235
|
*/
|
|
@@ -11704,7 +13239,7 @@ interface OperationMethods {
|
|
|
11704
13239
|
config?: AxiosRequestConfig
|
|
11705
13240
|
): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
|
|
11706
13241
|
/**
|
|
11707
|
-
* $validateAvailabilityFile - validateAvailabilityFile
|
|
13242
|
+
* $validateAvailabilityFile - $validateAvailabilityFile
|
|
11708
13243
|
*
|
|
11709
13244
|
* Validates an availability file, it returns an array of errors if the file is invalid
|
|
11710
13245
|
*/
|
|
@@ -11714,7 +13249,7 @@ interface OperationMethods {
|
|
|
11714
13249
|
config?: AxiosRequestConfig
|
|
11715
13250
|
): OperationResponse<Paths.$ValidateAvailabilityFile.Responses.$200>
|
|
11716
13251
|
/**
|
|
11717
|
-
* $historicMarketPrices - historicMarketPrices
|
|
13252
|
+
* $historicMarketPrices - $historicMarketPrices
|
|
11718
13253
|
*
|
|
11719
13254
|
* Get a series of historic energy prices for a given time period, market and bidding zone.
|
|
11720
13255
|
*/
|
|
@@ -11724,7 +13259,7 @@ interface OperationMethods {
|
|
|
11724
13259
|
config?: AxiosRequestConfig
|
|
11725
13260
|
): OperationResponse<Paths.$HistoricMarketPrices.Responses.$200>
|
|
11726
13261
|
/**
|
|
11727
|
-
* $averageMarketPrice - averageMarketPrice
|
|
13262
|
+
* $averageMarketPrice - $averageMarketPrice
|
|
11728
13263
|
*
|
|
11729
13264
|
* Get the average energy prices for a given time period, market and bidding zone.
|
|
11730
13265
|
*/
|
|
@@ -11734,7 +13269,7 @@ interface OperationMethods {
|
|
|
11734
13269
|
config?: AxiosRequestConfig
|
|
11735
13270
|
): OperationResponse<Paths.$AverageMarketPrice.Responses.$200>
|
|
11736
13271
|
/**
|
|
11737
|
-
* $searchExternalProducts - searchExternalProducts
|
|
13272
|
+
* $searchExternalProducts - $searchExternalProducts
|
|
11738
13273
|
*
|
|
11739
13274
|
* Returns the list of available products with computed prices based on a given context and for a given org integration.
|
|
11740
13275
|
*/
|
|
@@ -11744,7 +13279,7 @@ interface OperationMethods {
|
|
|
11744
13279
|
config?: AxiosRequestConfig
|
|
11745
13280
|
): OperationResponse<Paths.$SearchExternalProducts.Responses.$200>
|
|
11746
13281
|
/**
|
|
11747
|
-
* $searchExternalProductRecommendations - searchExternalProductRecommendations
|
|
13282
|
+
* $searchExternalProductRecommendations - $searchExternalProductRecommendations
|
|
11748
13283
|
*
|
|
11749
13284
|
* Returns the list of available product recommendations with computed prices based on a given context and for a given org integration.
|
|
11750
13285
|
*/
|
|
@@ -11754,7 +13289,7 @@ interface OperationMethods {
|
|
|
11754
13289
|
config?: AxiosRequestConfig
|
|
11755
13290
|
): OperationResponse<Paths.$SearchExternalProductRecommendations.Responses.$200>
|
|
11756
13291
|
/**
|
|
11757
|
-
* $searchProviders - searchProviders
|
|
13292
|
+
* $searchProviders - $searchProviders
|
|
11758
13293
|
*
|
|
11759
13294
|
* Returns the list of providers available based on a given location
|
|
11760
13295
|
*/
|
|
@@ -11764,7 +13299,7 @@ interface OperationMethods {
|
|
|
11764
13299
|
config?: AxiosRequestConfig
|
|
11765
13300
|
): OperationResponse<Paths.$SearchProviders.Responses.$200>
|
|
11766
13301
|
/**
|
|
11767
|
-
* $searchStreets - searchStreets
|
|
13302
|
+
* $searchStreets - $searchStreets
|
|
11768
13303
|
*
|
|
11769
13304
|
* Returns the list of streets available for a given postal code and city
|
|
11770
13305
|
*/
|
|
@@ -11774,7 +13309,7 @@ interface OperationMethods {
|
|
|
11774
13309
|
config?: AxiosRequestConfig
|
|
11775
13310
|
): OperationResponse<Paths.$SearchStreets.Responses.$200>
|
|
11776
13311
|
/**
|
|
11777
|
-
* $computePrice -
|
|
13312
|
+
* $computePrice - $computePrice
|
|
11778
13313
|
*
|
|
11779
13314
|
* Returns the price for a given product type based on location and consumption
|
|
11780
13315
|
*/
|
|
@@ -11784,7 +13319,7 @@ interface OperationMethods {
|
|
|
11784
13319
|
config?: AxiosRequestConfig
|
|
11785
13320
|
): OperationResponse<Paths.$ComputePrice.Responses.$200>
|
|
11786
13321
|
/**
|
|
11787
|
-
* $getCredentials - getCredentials
|
|
13322
|
+
* $getCredentials - $getCredentials
|
|
11788
13323
|
*
|
|
11789
13324
|
* Gets the credentials for a given integration / organization
|
|
11790
13325
|
*/
|
|
@@ -11794,7 +13329,7 @@ interface OperationMethods {
|
|
|
11794
13329
|
config?: AxiosRequestConfig
|
|
11795
13330
|
): OperationResponse<Paths.$GetCredentials.Responses.$200>
|
|
11796
13331
|
/**
|
|
11797
|
-
* $saveCredentials - saveCredentials
|
|
13332
|
+
* $saveCredentials - $saveCredentials
|
|
11798
13333
|
*
|
|
11799
13334
|
* Saves the credentials for a given integration / organization
|
|
11800
13335
|
*/
|
|
@@ -11804,7 +13339,7 @@ interface OperationMethods {
|
|
|
11804
13339
|
config?: AxiosRequestConfig
|
|
11805
13340
|
): OperationResponse<Paths.$SaveCredentials.Responses.$204>
|
|
11806
13341
|
/**
|
|
11807
|
-
* $deleteCredentials - deleteCredentials
|
|
13342
|
+
* $deleteCredentials - $deleteCredentials
|
|
11808
13343
|
*
|
|
11809
13344
|
* Delete the credentials for a given integration / organization
|
|
11810
13345
|
*/
|
|
@@ -11814,7 +13349,7 @@ interface OperationMethods {
|
|
|
11814
13349
|
config?: AxiosRequestConfig
|
|
11815
13350
|
): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
|
|
11816
13351
|
/**
|
|
11817
|
-
* $getExternalCatalogProducts - getExternalCatalogProducts
|
|
13352
|
+
* $getExternalCatalogProducts - $getExternalCatalogProducts
|
|
11818
13353
|
*
|
|
11819
13354
|
* Returns the list of available external catalog products with computed prices based on a given context
|
|
11820
13355
|
*/
|
|
@@ -11824,7 +13359,7 @@ interface OperationMethods {
|
|
|
11824
13359
|
config?: AxiosRequestConfig
|
|
11825
13360
|
): OperationResponse<Paths.$GetExternalCatalogProducts.Responses.$200>
|
|
11826
13361
|
/**
|
|
11827
|
-
* $getExternalCatalogProductRecommendations - getExternalCatalogProductRecommendations
|
|
13362
|
+
* $getExternalCatalogProductRecommendations - $getExternalCatalogProductRecommendations
|
|
11828
13363
|
*
|
|
11829
13364
|
* Returns the list of available external catalog products recommendations based on a given context
|
|
11830
13365
|
*/
|
|
@@ -11834,7 +13369,7 @@ interface OperationMethods {
|
|
|
11834
13369
|
config?: AxiosRequestConfig
|
|
11835
13370
|
): OperationResponse<Paths.$GetExternalCatalogProductRecommendations.Responses.$200>
|
|
11836
13371
|
/**
|
|
11837
|
-
* $productRecommendations - productRecommendations
|
|
13372
|
+
* $productRecommendations - $productRecommendations
|
|
11838
13373
|
*
|
|
11839
13374
|
* Get a list of product recommendations based on the search parameters.
|
|
11840
13375
|
*/
|
|
@@ -11843,12 +13378,294 @@ interface OperationMethods {
|
|
|
11843
13378
|
data?: Paths.$ProductRecommendations.RequestBody,
|
|
11844
13379
|
config?: AxiosRequestConfig
|
|
11845
13380
|
): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
|
|
13381
|
+
/**
|
|
13382
|
+
* $getConditionSets - $getConditionSets
|
|
13383
|
+
*
|
|
13384
|
+
* Returns the condition sets built in for one conditional entity type: the situations a
|
|
13385
|
+
* conditional Product, Price or Coupon is commonly varied by, ready to be copied into that
|
|
13386
|
+
* schema's `conditions` array and extended or modified from there.
|
|
13387
|
+
*
|
|
13388
|
+
* Which sets exist depends on the schema — an offer window is a Product's dimension, a delivery
|
|
13389
|
+
* area is a Price's and a Coupon's — so only the sets built in for `slug` are returned.
|
|
13390
|
+
*
|
|
13391
|
+
* Static, read-only reference data. The catalog is the same for every organization and is not
|
|
13392
|
+
* applied to any schema by this endpoint — adding conditions to a schema stays an Entity API
|
|
13393
|
+
* write.
|
|
13394
|
+
*
|
|
13395
|
+
*/
|
|
13396
|
+
'$getConditionSets'(
|
|
13397
|
+
parameters?: Parameters<Paths.$GetConditionSets.PathParameters> | null,
|
|
13398
|
+
data?: any,
|
|
13399
|
+
config?: AxiosRequestConfig
|
|
13400
|
+
): OperationResponse<Paths.$GetConditionSets.Responses.$200>
|
|
13401
|
+
/**
|
|
13402
|
+
* $resolveConditionalEntity - $resolveConditionalEntity
|
|
13403
|
+
*
|
|
13404
|
+
* Resolves which of a conditional entity's variants apply to a situation, and returns each one
|
|
13405
|
+
* composed: the base entity overlaid with the values of the version in effect at `as_of`.
|
|
13406
|
+
*
|
|
13407
|
+
* Resolution is two selections in a fixed order — the variant, by matching `context` against
|
|
13408
|
+
* the conditions each variant pins; then the version, by `as_of`. It is always scoped to one
|
|
13409
|
+
* logical entity, so it stays a cheap, predictable lookup rather than an open search.
|
|
13410
|
+
*
|
|
13411
|
+
* Matching follows two rules worth knowing before assembling a context. A condition a variant
|
|
13412
|
+
* does **not** pin matches any value, which is what lets a condition be added to a schema
|
|
13413
|
+
* without breaking the variants that already exist. A condition **missing from `context`**,
|
|
13414
|
+
* however, does not satisfy one a variant pinned: an incomplete integration resolves to
|
|
13415
|
+
* nothing rather than silently matching another segment's variants.
|
|
13416
|
+
*
|
|
13417
|
+
* When nothing matches, the entity's `default` variant is returned if it has one. There is no
|
|
13418
|
+
* implicit fallback to the unmodified base entity — its values are the ones no variant
|
|
13419
|
+
* overrode, which is not an answer to "what applies here".
|
|
13420
|
+
*
|
|
13421
|
+
* Availability is a separate mechanism and is never consulted here.
|
|
13422
|
+
*
|
|
13423
|
+
*/
|
|
13424
|
+
'$resolveConditionalEntity'(
|
|
13425
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13426
|
+
data?: Paths.$ResolveConditionalEntity.RequestBody,
|
|
13427
|
+
config?: AxiosRequestConfig
|
|
13428
|
+
): OperationResponse<Paths.$ResolveConditionalEntity.Responses.$200>
|
|
13429
|
+
/**
|
|
13430
|
+
* $createConditionalVariant - $createConditionalVariant
|
|
13431
|
+
*
|
|
13432
|
+
* Creates one variant of a conditional entity, together with the first version carrying its
|
|
13433
|
+
* values. Never two calls: a variant that existed without a version would be an entity holding
|
|
13434
|
+
* a condition tuple it cannot answer with.
|
|
13435
|
+
*
|
|
13436
|
+
* The body pins the situation the variant applies to. Pins are exact values only — predicates
|
|
13437
|
+
* are a read-side concept and are rejected here — and are stored canonicalized for their
|
|
13438
|
+
* condition's type, so two spellings of one instant, or one town written two ways, are one
|
|
13439
|
+
* variant rather than two that no context can tell apart.
|
|
13440
|
+
*
|
|
13441
|
+
* Three write rules are worth knowing before the first call:
|
|
13442
|
+
*
|
|
13443
|
+
* - A variant must pin at least one condition or be marked `default`. A variant pinning nothing
|
|
13444
|
+
* would be a universal wildcard matching every resolve, which is a far more dangerous thing
|
|
13445
|
+
* than a fallback and far easier to create by accident.
|
|
13446
|
+
* - `default` is a property of the variant, set by the `default` flag, and is never a value in
|
|
13447
|
+
* `conditions` — not even `false`. A `default` variant cannot pin anything else, and an entity
|
|
13448
|
+
* can have only one, enforced by the ordinary condition-tuple guard rather than by a rule of
|
|
13449
|
+
* its own. Any entity may have one; nothing is declared in the schema to allow it.
|
|
13450
|
+
* - Condition values are immutable afterwards. A variant's identity is the situation it applies
|
|
13451
|
+
* to, and orders and contracts pin it. **A condition added to a schema that already has
|
|
13452
|
+
* variants is effectively one-way**: every existing variant is a wildcard on the new
|
|
13453
|
+
* dimension, but the first variant that pins it is ambiguous against all of them, and
|
|
13454
|
+
* retro-pinning the others is blocked by this same rule.
|
|
13455
|
+
*
|
|
13456
|
+
* Attribute values are applied only for attributes currently carrying `overridable_attribute`.
|
|
13457
|
+
* Metadata and non-overridable fields present in the body are ignored rather than rejected, so a
|
|
13458
|
+
* client working from a slightly stale schema snapshot still succeeds.
|
|
13459
|
+
*
|
|
13460
|
+
* `variant_id` is always server-generated and returned, and is not accepted in the body — the
|
|
13461
|
+
* request schema admits no such property. It is the durable key orders and contracts pin, so it
|
|
13462
|
+
* cannot be something two independent importers could collide on.
|
|
13463
|
+
*
|
|
13464
|
+
*/
|
|
13465
|
+
'$createConditionalVariant'(
|
|
13466
|
+
parameters?: Parameters<Paths.$CreateConditionalVariant.PathParameters> | null,
|
|
13467
|
+
data?: Paths.$CreateConditionalVariant.RequestBody,
|
|
13468
|
+
config?: AxiosRequestConfig
|
|
13469
|
+
): OperationResponse<Paths.$CreateConditionalVariant.Responses.$201>
|
|
13470
|
+
/**
|
|
13471
|
+
* $getActiveConditionalVariantVersion - $getActiveConditionalVariantVersion
|
|
13472
|
+
*
|
|
13473
|
+
* Returns the version of this variant that is currently in effect — the one with the latest
|
|
13474
|
+
* `valid_from` at or before now.
|
|
13475
|
+
*
|
|
13476
|
+
* The "open this variant" read: no date arithmetic is asked of the caller, and what comes back
|
|
13477
|
+
* carries the `_revision` a write to that version has to be sent with, so an editing screen can
|
|
13478
|
+
* load and save without working out which version it is looking at.
|
|
13479
|
+
*
|
|
13480
|
+
* What is returned is the version's own attribute overrides, not the base entity overlaid with
|
|
13481
|
+
* them. Composing the two is what `:resolve` answers.
|
|
13482
|
+
*
|
|
13483
|
+
* A variant staged ahead of its launch has versions but none of them in effect, and is reported
|
|
13484
|
+
* as having none rather than as not existing — the two are fixed differently.
|
|
13485
|
+
*
|
|
13486
|
+
*/
|
|
13487
|
+
'$getActiveConditionalVariantVersion'(
|
|
13488
|
+
parameters?: Parameters<Paths.$GetActiveConditionalVariantVersion.PathParameters> | null,
|
|
13489
|
+
data?: any,
|
|
13490
|
+
config?: AxiosRequestConfig
|
|
13491
|
+
): OperationResponse<Paths.$GetActiveConditionalVariantVersion.Responses.$200>
|
|
13492
|
+
/**
|
|
13493
|
+
* $replaceActiveConditionalVariantVersion - $replaceActiveConditionalVariantVersion
|
|
13494
|
+
*
|
|
13495
|
+
* Replaces the values of the version currently in effect, wholesale.
|
|
13496
|
+
*
|
|
13497
|
+
* The body is the complete set of attribute overrides: an attribute the variant may override and
|
|
13498
|
+
* that is absent from it stops being overridden. Attributes the variant may **not** override are
|
|
13499
|
+
* ignored where the body carries them, and their stored value is kept rather than dropped — a
|
|
13500
|
+
* routine full-snapshot write must not erase an override the moment its attribute's flag happens
|
|
13501
|
+
* to be off.
|
|
13502
|
+
*
|
|
13503
|
+
* Editing the version in effect is the ordinary way a live price is corrected, and warns about
|
|
13504
|
+
* nothing: what changes is what that version *says*, not which version is in effect.
|
|
13505
|
+
*
|
|
13506
|
+
* Neither `valid_from` nor `conditions` can be changed here. Both are accepted when they match
|
|
13507
|
+
* what is stored, so a client building its body from the version it loaded need not strip them
|
|
13508
|
+
* out first, and both are refused when they name something else.
|
|
13509
|
+
*
|
|
13510
|
+
*/
|
|
13511
|
+
'$replaceActiveConditionalVariantVersion'(
|
|
13512
|
+
parameters?: Parameters<Paths.$ReplaceActiveConditionalVariantVersion.PathParameters> | null,
|
|
13513
|
+
data?: Paths.$ReplaceActiveConditionalVariantVersion.RequestBody,
|
|
13514
|
+
config?: AxiosRequestConfig
|
|
13515
|
+
): OperationResponse<Paths.$ReplaceActiveConditionalVariantVersion.Responses.$200>
|
|
13516
|
+
/**
|
|
13517
|
+
* $patchActiveConditionalVariantVersion - $patchActiveConditionalVariantVersion
|
|
13518
|
+
*
|
|
13519
|
+
* Changes only the fields it names on the version currently in effect.
|
|
13520
|
+
*
|
|
13521
|
+
* Everything the body does not mention is left as stored — the "just nudge this number" write. A
|
|
13522
|
+
* `null` is a value like any other rather than a deletion; a client that wants an attribute to
|
|
13523
|
+
* stop being overridden sends the complete snapshot without it through `PUT`.
|
|
13524
|
+
*
|
|
13525
|
+
* Attempting to change a pinned condition value is refused here in particular: a partial update
|
|
13526
|
+
* is the path a caller reaches for by accident, and a variant's conditions are the situation it
|
|
13527
|
+
* applies to, which the orders and contracts pinning it depend on not shifting.
|
|
13528
|
+
*
|
|
13529
|
+
*/
|
|
13530
|
+
'$patchActiveConditionalVariantVersion'(
|
|
13531
|
+
parameters?: Parameters<Paths.$PatchActiveConditionalVariantVersion.PathParameters> | null,
|
|
13532
|
+
data?: Paths.$PatchActiveConditionalVariantVersion.RequestBody,
|
|
13533
|
+
config?: AxiosRequestConfig
|
|
13534
|
+
): OperationResponse<Paths.$PatchActiveConditionalVariantVersion.Responses.$200>
|
|
13535
|
+
/**
|
|
13536
|
+
* $deleteConditionalVariant - $deleteConditionalVariant
|
|
13537
|
+
*
|
|
13538
|
+
* Removes one variant of a conditional entity: the condition tuple it holds, its registration
|
|
13539
|
+
* in the search index, and every version it accumulated.
|
|
13540
|
+
*
|
|
13541
|
+
* Two phases. The first frees the tuple and deregisters the variant, and is what makes the
|
|
13542
|
+
* combination of condition values immediately reusable — the second removes the version rows in
|
|
13543
|
+
* batches afterwards. A response arrives only once both have finished for this request, but the
|
|
13544
|
+
* tuple is reusable from the moment the first completes, whether or not the second did: a
|
|
13545
|
+
* variant with more versions than one transaction can carry is the ordinary case, not an edge
|
|
13546
|
+
* one. An interrupted delete is safe to send again; it picks up where it stopped.
|
|
13547
|
+
*
|
|
13548
|
+
* Nothing is archived. A variant an order or contract pins stops resolving, and hydration drops
|
|
13549
|
+
* the reference leniently rather than failing the read.
|
|
13550
|
+
*
|
|
13551
|
+
* This removes the **variant**, not one of its versions. To remove a single version, name it on
|
|
13552
|
+
* `…/variants/{variant_id}/versions/{valid_from}` — including the one currently in effect, which
|
|
13553
|
+
* deliberately has no "delete whichever is live" shorthand: that is exactly the write nobody
|
|
13554
|
+
* should be able to ask for without saying which version they meant.
|
|
13555
|
+
*
|
|
13556
|
+
*/
|
|
13557
|
+
'$deleteConditionalVariant'(
|
|
13558
|
+
parameters?: Parameters<Paths.$DeleteConditionalVariant.PathParameters> | null,
|
|
13559
|
+
data?: any,
|
|
13560
|
+
config?: AxiosRequestConfig
|
|
13561
|
+
): OperationResponse<Paths.$DeleteConditionalVariant.Responses.$200>
|
|
13562
|
+
/**
|
|
13563
|
+
* $appendConditionalVariantVersion - $appendConditionalVariantVersion
|
|
13564
|
+
*
|
|
13565
|
+
* Appends a version to a variant: a new set of values taking effect at its own instant.
|
|
13566
|
+
*
|
|
13567
|
+
* This is how a price changes. No version carries an end date and nothing is superseded
|
|
13568
|
+
* explicitly — the version in effect at an instant is simply the one with the latest `valid_from`
|
|
13569
|
+
* at or before it, so appending a later version is the whole of "this is the new price from then
|
|
13570
|
+
* on". A version dated in the future is staged and excluded from resolution until its date.
|
|
13571
|
+
*
|
|
13572
|
+
* **A version is never refused for being late.** A `valid_from` in the past is written like any
|
|
13573
|
+
* other and answered with warnings in `warnings` naming what it moved — what resolves now, what a
|
|
13574
|
+
* past-dated read returns, or both. Correcting a price that took effect last week is ordinary
|
|
13575
|
+
* work; the alternative, deleting and recreating the variant, breaks every order and contract
|
|
13576
|
+
* pinning its id.
|
|
13577
|
+
*
|
|
13578
|
+
* What is refused is appending at a `valid_from` the variant already has: that write means either
|
|
13579
|
+
* "replace it" or "and also this", and only the caller knows which. The two operations both
|
|
13580
|
+
* exist, on the dated version path.
|
|
13581
|
+
*
|
|
13582
|
+
* The variant's `conditions` are its identity and are fixed at creation; they may be sent back
|
|
13583
|
+
* unchanged but never changed.
|
|
13584
|
+
*
|
|
13585
|
+
*/
|
|
13586
|
+
'$appendConditionalVariantVersion'(
|
|
13587
|
+
parameters?: Parameters<Paths.$AppendConditionalVariantVersion.PathParameters> | null,
|
|
13588
|
+
data?: Paths.$AppendConditionalVariantVersion.RequestBody,
|
|
13589
|
+
config?: AxiosRequestConfig
|
|
13590
|
+
): OperationResponse<Paths.$AppendConditionalVariantVersion.Responses.$201>
|
|
13591
|
+
/**
|
|
13592
|
+
* $getConditionalVariantVersion - $getConditionalVariantVersion
|
|
13593
|
+
*
|
|
13594
|
+
* Returns one specific version of a variant, by the instant it takes effect — what a form editing
|
|
13595
|
+
* that version loads.
|
|
13596
|
+
*
|
|
13597
|
+
* Exact, never nearest: an instant the variant has no version at is a not-found rather than the
|
|
13598
|
+
* version that would be in effect at it. That question is the shorthand read's, or `:resolve`'s.
|
|
13599
|
+
*
|
|
13600
|
+
*/
|
|
13601
|
+
'$getConditionalVariantVersion'(
|
|
13602
|
+
parameters?: Parameters<Paths.$GetConditionalVariantVersion.PathParameters> | null,
|
|
13603
|
+
data?: any,
|
|
13604
|
+
config?: AxiosRequestConfig
|
|
13605
|
+
): OperationResponse<Paths.$GetConditionalVariantVersion.Responses.$200>
|
|
13606
|
+
/**
|
|
13607
|
+
* $replaceConditionalVariantVersion - $replaceConditionalVariantVersion
|
|
13608
|
+
*
|
|
13609
|
+
* Replaces one version's values wholesale, addressed by its `valid_from`.
|
|
13610
|
+
*
|
|
13611
|
+
* Editable whatever its date, at both ends of the timeline: a scheduled version must stay
|
|
13612
|
+
* editable so a staged price can be corrected before it goes live rather than accumulating dead
|
|
13613
|
+
* versions beside it, and a past one must stay editable because correcting history is ordinary
|
|
13614
|
+
* work. Writing a superseded version is answered with a warning naming what a past-dated read now
|
|
13615
|
+
* returns; it is not refused.
|
|
13616
|
+
*
|
|
13617
|
+
* Attributes the variant may not override are ignored where the body carries them, and their
|
|
13618
|
+
* stored value is preserved rather than dropped.
|
|
13619
|
+
*
|
|
13620
|
+
*/
|
|
13621
|
+
'$replaceConditionalVariantVersion'(
|
|
13622
|
+
parameters?: Parameters<Paths.$ReplaceConditionalVariantVersion.PathParameters> | null,
|
|
13623
|
+
data?: Paths.$ReplaceConditionalVariantVersion.RequestBody,
|
|
13624
|
+
config?: AxiosRequestConfig
|
|
13625
|
+
): OperationResponse<Paths.$ReplaceConditionalVariantVersion.Responses.$200>
|
|
13626
|
+
/**
|
|
13627
|
+
* $patchConditionalVariantVersion - $patchConditionalVariantVersion
|
|
13628
|
+
*
|
|
13629
|
+
* Changes only the fields it names on one version, addressed by its `valid_from`.
|
|
13630
|
+
*
|
|
13631
|
+
* Everything the body does not mention is left as stored. A partial update that tries to change a
|
|
13632
|
+
* pinned condition value is refused: condition values are immutable after a variant is created,
|
|
13633
|
+
* and this is the path that rule is most likely to be broken on by accident.
|
|
13634
|
+
*
|
|
13635
|
+
*/
|
|
13636
|
+
'$patchConditionalVariantVersion'(
|
|
13637
|
+
parameters?: Parameters<Paths.$PatchConditionalVariantVersion.PathParameters> | null,
|
|
13638
|
+
data?: Paths.$PatchConditionalVariantVersion.RequestBody,
|
|
13639
|
+
config?: AxiosRequestConfig
|
|
13640
|
+
): OperationResponse<Paths.$PatchConditionalVariantVersion.Responses.$200>
|
|
13641
|
+
/**
|
|
13642
|
+
* $deleteConditionalVariantVersion - $deleteConditionalVariantVersion
|
|
13643
|
+
*
|
|
13644
|
+
* Removes one version of a variant.
|
|
13645
|
+
*
|
|
13646
|
+
* Withdrawing a scheduled adjustment is what this is for, and deleting a future version warns
|
|
13647
|
+
* about nothing — nothing that has resolved, or could have resolved, changes. Deleting a version
|
|
13648
|
+
* that has taken effect is allowed too and answered with a warning: it changes what a past-dated
|
|
13649
|
+
* read returns, and if it was the version in effect it changes what resolves now.
|
|
13650
|
+
*
|
|
13651
|
+
* **A variant's last remaining version cannot be deleted.** Such a variant would still hold its
|
|
13652
|
+
* condition tuple and still be selectable, and then resolve to nothing — which is a variant delete
|
|
13653
|
+
* wearing a version delete's clothes. Delete the variant instead; that frees the tuple too.
|
|
13654
|
+
*
|
|
13655
|
+
* The variant itself is untouched: it keeps its conditions, its tuple and its place in the index.
|
|
13656
|
+
*
|
|
13657
|
+
*/
|
|
13658
|
+
'$deleteConditionalVariantVersion'(
|
|
13659
|
+
parameters?: Parameters<Paths.$DeleteConditionalVariantVersion.QueryParameters & Paths.$DeleteConditionalVariantVersion.PathParameters> | null,
|
|
13660
|
+
data?: any,
|
|
13661
|
+
config?: AxiosRequestConfig
|
|
13662
|
+
): OperationResponse<Paths.$DeleteConditionalVariantVersion.Responses.$200>
|
|
11846
13663
|
}
|
|
11847
13664
|
|
|
11848
13665
|
interface PathsDictionary {
|
|
11849
13666
|
['/v1/pricing:compute']: {
|
|
11850
13667
|
/**
|
|
11851
|
-
* $calculatePricingDetails - calculatePricingDetails
|
|
13668
|
+
* $calculatePricingDetails - $calculatePricingDetails
|
|
11852
13669
|
*
|
|
11853
13670
|
* Computes a set of pricing details that can be persisted on an entity with the pricing capability enabled, e.g: Orders or Contracts.
|
|
11854
13671
|
*/
|
|
@@ -11884,7 +13701,7 @@ interface PathsDictionary {
|
|
|
11884
13701
|
}
|
|
11885
13702
|
['/v1/public/cart:checkout']: {
|
|
11886
13703
|
/**
|
|
11887
|
-
* $checkoutCart - checkoutCart
|
|
13704
|
+
* $checkoutCart - $checkoutCart
|
|
11888
13705
|
*
|
|
11889
13706
|
* Checkouts a cart and executes the specified checkout `mode` process.
|
|
11890
13707
|
*
|
|
@@ -11907,7 +13724,7 @@ interface PathsDictionary {
|
|
|
11907
13724
|
}
|
|
11908
13725
|
['/v1/public/catalog']: {
|
|
11909
13726
|
/**
|
|
11910
|
-
* $searchCatalog - searchCatalog
|
|
13727
|
+
* $searchCatalog - $searchCatalog
|
|
11911
13728
|
*
|
|
11912
13729
|
* Provides a querying functionalities over products and prices of the Catalog for a given organization.
|
|
11913
13730
|
*/
|
|
@@ -11919,7 +13736,7 @@ interface PathsDictionary {
|
|
|
11919
13736
|
}
|
|
11920
13737
|
['/v1/catalog']: {
|
|
11921
13738
|
/**
|
|
11922
|
-
* $privateSearchCatalog - privateSearchCatalog
|
|
13739
|
+
* $privateSearchCatalog - $privateSearchCatalog
|
|
11923
13740
|
*
|
|
11924
13741
|
* Provides a querying functionalities over products and prices of the Catalog for a given organization.
|
|
11925
13742
|
*/
|
|
@@ -11931,7 +13748,7 @@ interface PathsDictionary {
|
|
|
11931
13748
|
}
|
|
11932
13749
|
['/v1/public/validate-promo-codes']: {
|
|
11933
13750
|
/**
|
|
11934
|
-
* $validatePromoCodes - validatePromoCodes
|
|
13751
|
+
* $validatePromoCodes - $validatePromoCodes
|
|
11935
13752
|
*
|
|
11936
13753
|
* Validate a list of promo codes against a list of coupons
|
|
11937
13754
|
*/
|
|
@@ -11943,7 +13760,7 @@ interface PathsDictionary {
|
|
|
11943
13760
|
}
|
|
11944
13761
|
['/v1/public/availability:check']: {
|
|
11945
13762
|
/**
|
|
11946
|
-
* $availabilityCheck - availabilityCheck
|
|
13763
|
+
* $availabilityCheck - $availabilityCheck
|
|
11947
13764
|
*
|
|
11948
13765
|
* The availability check endpoint
|
|
11949
13766
|
*/
|
|
@@ -11955,7 +13772,7 @@ interface PathsDictionary {
|
|
|
11955
13772
|
}
|
|
11956
13773
|
['/v1/validate-availability/{id}']: {
|
|
11957
13774
|
/**
|
|
11958
|
-
* $validateAvailabilityFile - validateAvailabilityFile
|
|
13775
|
+
* $validateAvailabilityFile - $validateAvailabilityFile
|
|
11959
13776
|
*
|
|
11960
13777
|
* Validates an availability file, it returns an array of errors if the file is invalid
|
|
11961
13778
|
*/
|
|
@@ -11967,7 +13784,7 @@ interface PathsDictionary {
|
|
|
11967
13784
|
}
|
|
11968
13785
|
['/v1/public/historicMarketPrices']: {
|
|
11969
13786
|
/**
|
|
11970
|
-
* $historicMarketPrices - historicMarketPrices
|
|
13787
|
+
* $historicMarketPrices - $historicMarketPrices
|
|
11971
13788
|
*
|
|
11972
13789
|
* Get a series of historic energy prices for a given time period, market and bidding zone.
|
|
11973
13790
|
*/
|
|
@@ -11979,7 +13796,7 @@ interface PathsDictionary {
|
|
|
11979
13796
|
}
|
|
11980
13797
|
['/v1/public/averageMarketPrice']: {
|
|
11981
13798
|
/**
|
|
11982
|
-
* $averageMarketPrice - averageMarketPrice
|
|
13799
|
+
* $averageMarketPrice - $averageMarketPrice
|
|
11983
13800
|
*
|
|
11984
13801
|
* Get the average energy prices for a given time period, market and bidding zone.
|
|
11985
13802
|
*/
|
|
@@ -11991,7 +13808,7 @@ interface PathsDictionary {
|
|
|
11991
13808
|
}
|
|
11992
13809
|
['/v1/public/integration/{integrationId}/products']: {
|
|
11993
13810
|
/**
|
|
11994
|
-
* $searchExternalProducts - searchExternalProducts
|
|
13811
|
+
* $searchExternalProducts - $searchExternalProducts
|
|
11995
13812
|
*
|
|
11996
13813
|
* Returns the list of available products with computed prices based on a given context and for a given org integration.
|
|
11997
13814
|
*/
|
|
@@ -12003,7 +13820,7 @@ interface PathsDictionary {
|
|
|
12003
13820
|
}
|
|
12004
13821
|
['/v1/public/integration/{integrationId}/product-recommendations']: {
|
|
12005
13822
|
/**
|
|
12006
|
-
* $searchExternalProductRecommendations - searchExternalProductRecommendations
|
|
13823
|
+
* $searchExternalProductRecommendations - $searchExternalProductRecommendations
|
|
12007
13824
|
*
|
|
12008
13825
|
* Returns the list of available product recommendations with computed prices based on a given context and for a given org integration.
|
|
12009
13826
|
*/
|
|
@@ -12015,7 +13832,7 @@ interface PathsDictionary {
|
|
|
12015
13832
|
}
|
|
12016
13833
|
['/v1/public/integration/{integrationId}/providers:search']: {
|
|
12017
13834
|
/**
|
|
12018
|
-
* $searchProviders - searchProviders
|
|
13835
|
+
* $searchProviders - $searchProviders
|
|
12019
13836
|
*
|
|
12020
13837
|
* Returns the list of providers available based on a given location
|
|
12021
13838
|
*/
|
|
@@ -12027,7 +13844,7 @@ interface PathsDictionary {
|
|
|
12027
13844
|
}
|
|
12028
13845
|
['/v1/public/integration/{integrationId}/streets:search']: {
|
|
12029
13846
|
/**
|
|
12030
|
-
* $searchStreets - searchStreets
|
|
13847
|
+
* $searchStreets - $searchStreets
|
|
12031
13848
|
*
|
|
12032
13849
|
* Returns the list of streets available for a given postal code and city
|
|
12033
13850
|
*/
|
|
@@ -12039,7 +13856,7 @@ interface PathsDictionary {
|
|
|
12039
13856
|
}
|
|
12040
13857
|
['/v1/public/integration/{integrationId}/compute-price']: {
|
|
12041
13858
|
/**
|
|
12042
|
-
* $computePrice -
|
|
13859
|
+
* $computePrice - $computePrice
|
|
12043
13860
|
*
|
|
12044
13861
|
* Returns the price for a given product type based on location and consumption
|
|
12045
13862
|
*/
|
|
@@ -12051,7 +13868,7 @@ interface PathsDictionary {
|
|
|
12051
13868
|
}
|
|
12052
13869
|
['/v1/integration/{integrationId}/credentials']: {
|
|
12053
13870
|
/**
|
|
12054
|
-
* $getCredentials - getCredentials
|
|
13871
|
+
* $getCredentials - $getCredentials
|
|
12055
13872
|
*
|
|
12056
13873
|
* Gets the credentials for a given integration / organization
|
|
12057
13874
|
*/
|
|
@@ -12063,7 +13880,7 @@ interface PathsDictionary {
|
|
|
12063
13880
|
}
|
|
12064
13881
|
['/v1/integration/{integrationId}/credentials:save']: {
|
|
12065
13882
|
/**
|
|
12066
|
-
* $saveCredentials - saveCredentials
|
|
13883
|
+
* $saveCredentials - $saveCredentials
|
|
12067
13884
|
*
|
|
12068
13885
|
* Saves the credentials for a given integration / organization
|
|
12069
13886
|
*/
|
|
@@ -12075,7 +13892,7 @@ interface PathsDictionary {
|
|
|
12075
13892
|
}
|
|
12076
13893
|
['/v1/integration/{integrationId}/credentials:delete']: {
|
|
12077
13894
|
/**
|
|
12078
|
-
* $deleteCredentials - deleteCredentials
|
|
13895
|
+
* $deleteCredentials - $deleteCredentials
|
|
12079
13896
|
*
|
|
12080
13897
|
* Delete the credentials for a given integration / organization
|
|
12081
13898
|
*/
|
|
@@ -12087,7 +13904,7 @@ interface PathsDictionary {
|
|
|
12087
13904
|
}
|
|
12088
13905
|
['/v1/public/external-catalog/products']: {
|
|
12089
13906
|
/**
|
|
12090
|
-
* $getExternalCatalogProducts - getExternalCatalogProducts
|
|
13907
|
+
* $getExternalCatalogProducts - $getExternalCatalogProducts
|
|
12091
13908
|
*
|
|
12092
13909
|
* Returns the list of available external catalog products with computed prices based on a given context
|
|
12093
13910
|
*/
|
|
@@ -12099,7 +13916,7 @@ interface PathsDictionary {
|
|
|
12099
13916
|
}
|
|
12100
13917
|
['/v1/public/external-catalog/product-recommendations']: {
|
|
12101
13918
|
/**
|
|
12102
|
-
* $getExternalCatalogProductRecommendations - getExternalCatalogProductRecommendations
|
|
13919
|
+
* $getExternalCatalogProductRecommendations - $getExternalCatalogProductRecommendations
|
|
12103
13920
|
*
|
|
12104
13921
|
* Returns the list of available external catalog products recommendations based on a given context
|
|
12105
13922
|
*/
|
|
@@ -12111,7 +13928,7 @@ interface PathsDictionary {
|
|
|
12111
13928
|
}
|
|
12112
13929
|
['/v1/public/product-recommendations']: {
|
|
12113
13930
|
/**
|
|
12114
|
-
* $productRecommendations - productRecommendations
|
|
13931
|
+
* $productRecommendations - $productRecommendations
|
|
12115
13932
|
*
|
|
12116
13933
|
* Get a list of product recommendations based on the search parameters.
|
|
12117
13934
|
*/
|
|
@@ -12121,6 +13938,300 @@ interface PathsDictionary {
|
|
|
12121
13938
|
config?: AxiosRequestConfig
|
|
12122
13939
|
): OperationResponse<Paths.$ProductRecommendations.Responses.$200>
|
|
12123
13940
|
}
|
|
13941
|
+
['/v1/conditional-pricing/{slug}/condition-sets']: {
|
|
13942
|
+
/**
|
|
13943
|
+
* $getConditionSets - $getConditionSets
|
|
13944
|
+
*
|
|
13945
|
+
* Returns the condition sets built in for one conditional entity type: the situations a
|
|
13946
|
+
* conditional Product, Price or Coupon is commonly varied by, ready to be copied into that
|
|
13947
|
+
* schema's `conditions` array and extended or modified from there.
|
|
13948
|
+
*
|
|
13949
|
+
* Which sets exist depends on the schema — an offer window is a Product's dimension, a delivery
|
|
13950
|
+
* area is a Price's and a Coupon's — so only the sets built in for `slug` are returned.
|
|
13951
|
+
*
|
|
13952
|
+
* Static, read-only reference data. The catalog is the same for every organization and is not
|
|
13953
|
+
* applied to any schema by this endpoint — adding conditions to a schema stays an Entity API
|
|
13954
|
+
* write.
|
|
13955
|
+
*
|
|
13956
|
+
*/
|
|
13957
|
+
'get'(
|
|
13958
|
+
parameters?: Parameters<Paths.$GetConditionSets.PathParameters> | null,
|
|
13959
|
+
data?: any,
|
|
13960
|
+
config?: AxiosRequestConfig
|
|
13961
|
+
): OperationResponse<Paths.$GetConditionSets.Responses.$200>
|
|
13962
|
+
}
|
|
13963
|
+
['/v1/conditional-pricing:resolve']: {
|
|
13964
|
+
/**
|
|
13965
|
+
* $resolveConditionalEntity - $resolveConditionalEntity
|
|
13966
|
+
*
|
|
13967
|
+
* Resolves which of a conditional entity's variants apply to a situation, and returns each one
|
|
13968
|
+
* composed: the base entity overlaid with the values of the version in effect at `as_of`.
|
|
13969
|
+
*
|
|
13970
|
+
* Resolution is two selections in a fixed order — the variant, by matching `context` against
|
|
13971
|
+
* the conditions each variant pins; then the version, by `as_of`. It is always scoped to one
|
|
13972
|
+
* logical entity, so it stays a cheap, predictable lookup rather than an open search.
|
|
13973
|
+
*
|
|
13974
|
+
* Matching follows two rules worth knowing before assembling a context. A condition a variant
|
|
13975
|
+
* does **not** pin matches any value, which is what lets a condition be added to a schema
|
|
13976
|
+
* without breaking the variants that already exist. A condition **missing from `context`**,
|
|
13977
|
+
* however, does not satisfy one a variant pinned: an incomplete integration resolves to
|
|
13978
|
+
* nothing rather than silently matching another segment's variants.
|
|
13979
|
+
*
|
|
13980
|
+
* When nothing matches, the entity's `default` variant is returned if it has one. There is no
|
|
13981
|
+
* implicit fallback to the unmodified base entity — its values are the ones no variant
|
|
13982
|
+
* overrode, which is not an answer to "what applies here".
|
|
13983
|
+
*
|
|
13984
|
+
* Availability is a separate mechanism and is never consulted here.
|
|
13985
|
+
*
|
|
13986
|
+
*/
|
|
13987
|
+
'post'(
|
|
13988
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13989
|
+
data?: Paths.$ResolveConditionalEntity.RequestBody,
|
|
13990
|
+
config?: AxiosRequestConfig
|
|
13991
|
+
): OperationResponse<Paths.$ResolveConditionalEntity.Responses.$200>
|
|
13992
|
+
}
|
|
13993
|
+
['/v1/conditional-pricing/{slug}/entities/{entity_id}/variants']: {
|
|
13994
|
+
/**
|
|
13995
|
+
* $createConditionalVariant - $createConditionalVariant
|
|
13996
|
+
*
|
|
13997
|
+
* Creates one variant of a conditional entity, together with the first version carrying its
|
|
13998
|
+
* values. Never two calls: a variant that existed without a version would be an entity holding
|
|
13999
|
+
* a condition tuple it cannot answer with.
|
|
14000
|
+
*
|
|
14001
|
+
* The body pins the situation the variant applies to. Pins are exact values only — predicates
|
|
14002
|
+
* are a read-side concept and are rejected here — and are stored canonicalized for their
|
|
14003
|
+
* condition's type, so two spellings of one instant, or one town written two ways, are one
|
|
14004
|
+
* variant rather than two that no context can tell apart.
|
|
14005
|
+
*
|
|
14006
|
+
* Three write rules are worth knowing before the first call:
|
|
14007
|
+
*
|
|
14008
|
+
* - A variant must pin at least one condition or be marked `default`. A variant pinning nothing
|
|
14009
|
+
* would be a universal wildcard matching every resolve, which is a far more dangerous thing
|
|
14010
|
+
* than a fallback and far easier to create by accident.
|
|
14011
|
+
* - `default` is a property of the variant, set by the `default` flag, and is never a value in
|
|
14012
|
+
* `conditions` — not even `false`. A `default` variant cannot pin anything else, and an entity
|
|
14013
|
+
* can have only one, enforced by the ordinary condition-tuple guard rather than by a rule of
|
|
14014
|
+
* its own. Any entity may have one; nothing is declared in the schema to allow it.
|
|
14015
|
+
* - Condition values are immutable afterwards. A variant's identity is the situation it applies
|
|
14016
|
+
* to, and orders and contracts pin it. **A condition added to a schema that already has
|
|
14017
|
+
* variants is effectively one-way**: every existing variant is a wildcard on the new
|
|
14018
|
+
* dimension, but the first variant that pins it is ambiguous against all of them, and
|
|
14019
|
+
* retro-pinning the others is blocked by this same rule.
|
|
14020
|
+
*
|
|
14021
|
+
* Attribute values are applied only for attributes currently carrying `overridable_attribute`.
|
|
14022
|
+
* Metadata and non-overridable fields present in the body are ignored rather than rejected, so a
|
|
14023
|
+
* client working from a slightly stale schema snapshot still succeeds.
|
|
14024
|
+
*
|
|
14025
|
+
* `variant_id` is always server-generated and returned, and is not accepted in the body — the
|
|
14026
|
+
* request schema admits no such property. It is the durable key orders and contracts pin, so it
|
|
14027
|
+
* cannot be something two independent importers could collide on.
|
|
14028
|
+
*
|
|
14029
|
+
*/
|
|
14030
|
+
'post'(
|
|
14031
|
+
parameters?: Parameters<Paths.$CreateConditionalVariant.PathParameters> | null,
|
|
14032
|
+
data?: Paths.$CreateConditionalVariant.RequestBody,
|
|
14033
|
+
config?: AxiosRequestConfig
|
|
14034
|
+
): OperationResponse<Paths.$CreateConditionalVariant.Responses.$201>
|
|
14035
|
+
}
|
|
14036
|
+
['/v1/conditional-pricing/{slug}/entities/{entity_id}/variants/{variant_id}']: {
|
|
14037
|
+
/**
|
|
14038
|
+
* $getActiveConditionalVariantVersion - $getActiveConditionalVariantVersion
|
|
14039
|
+
*
|
|
14040
|
+
* Returns the version of this variant that is currently in effect — the one with the latest
|
|
14041
|
+
* `valid_from` at or before now.
|
|
14042
|
+
*
|
|
14043
|
+
* The "open this variant" read: no date arithmetic is asked of the caller, and what comes back
|
|
14044
|
+
* carries the `_revision` a write to that version has to be sent with, so an editing screen can
|
|
14045
|
+
* load and save without working out which version it is looking at.
|
|
14046
|
+
*
|
|
14047
|
+
* What is returned is the version's own attribute overrides, not the base entity overlaid with
|
|
14048
|
+
* them. Composing the two is what `:resolve` answers.
|
|
14049
|
+
*
|
|
14050
|
+
* A variant staged ahead of its launch has versions but none of them in effect, and is reported
|
|
14051
|
+
* as having none rather than as not existing — the two are fixed differently.
|
|
14052
|
+
*
|
|
14053
|
+
*/
|
|
14054
|
+
'get'(
|
|
14055
|
+
parameters?: Parameters<Paths.$GetActiveConditionalVariantVersion.PathParameters> | null,
|
|
14056
|
+
data?: any,
|
|
14057
|
+
config?: AxiosRequestConfig
|
|
14058
|
+
): OperationResponse<Paths.$GetActiveConditionalVariantVersion.Responses.$200>
|
|
14059
|
+
/**
|
|
14060
|
+
* $replaceActiveConditionalVariantVersion - $replaceActiveConditionalVariantVersion
|
|
14061
|
+
*
|
|
14062
|
+
* Replaces the values of the version currently in effect, wholesale.
|
|
14063
|
+
*
|
|
14064
|
+
* The body is the complete set of attribute overrides: an attribute the variant may override and
|
|
14065
|
+
* that is absent from it stops being overridden. Attributes the variant may **not** override are
|
|
14066
|
+
* ignored where the body carries them, and their stored value is kept rather than dropped — a
|
|
14067
|
+
* routine full-snapshot write must not erase an override the moment its attribute's flag happens
|
|
14068
|
+
* to be off.
|
|
14069
|
+
*
|
|
14070
|
+
* Editing the version in effect is the ordinary way a live price is corrected, and warns about
|
|
14071
|
+
* nothing: what changes is what that version *says*, not which version is in effect.
|
|
14072
|
+
*
|
|
14073
|
+
* Neither `valid_from` nor `conditions` can be changed here. Both are accepted when they match
|
|
14074
|
+
* what is stored, so a client building its body from the version it loaded need not strip them
|
|
14075
|
+
* out first, and both are refused when they name something else.
|
|
14076
|
+
*
|
|
14077
|
+
*/
|
|
14078
|
+
'put'(
|
|
14079
|
+
parameters?: Parameters<Paths.$ReplaceActiveConditionalVariantVersion.PathParameters> | null,
|
|
14080
|
+
data?: Paths.$ReplaceActiveConditionalVariantVersion.RequestBody,
|
|
14081
|
+
config?: AxiosRequestConfig
|
|
14082
|
+
): OperationResponse<Paths.$ReplaceActiveConditionalVariantVersion.Responses.$200>
|
|
14083
|
+
/**
|
|
14084
|
+
* $patchActiveConditionalVariantVersion - $patchActiveConditionalVariantVersion
|
|
14085
|
+
*
|
|
14086
|
+
* Changes only the fields it names on the version currently in effect.
|
|
14087
|
+
*
|
|
14088
|
+
* Everything the body does not mention is left as stored — the "just nudge this number" write. A
|
|
14089
|
+
* `null` is a value like any other rather than a deletion; a client that wants an attribute to
|
|
14090
|
+
* stop being overridden sends the complete snapshot without it through `PUT`.
|
|
14091
|
+
*
|
|
14092
|
+
* Attempting to change a pinned condition value is refused here in particular: a partial update
|
|
14093
|
+
* is the path a caller reaches for by accident, and a variant's conditions are the situation it
|
|
14094
|
+
* applies to, which the orders and contracts pinning it depend on not shifting.
|
|
14095
|
+
*
|
|
14096
|
+
*/
|
|
14097
|
+
'patch'(
|
|
14098
|
+
parameters?: Parameters<Paths.$PatchActiveConditionalVariantVersion.PathParameters> | null,
|
|
14099
|
+
data?: Paths.$PatchActiveConditionalVariantVersion.RequestBody,
|
|
14100
|
+
config?: AxiosRequestConfig
|
|
14101
|
+
): OperationResponse<Paths.$PatchActiveConditionalVariantVersion.Responses.$200>
|
|
14102
|
+
/**
|
|
14103
|
+
* $deleteConditionalVariant - $deleteConditionalVariant
|
|
14104
|
+
*
|
|
14105
|
+
* Removes one variant of a conditional entity: the condition tuple it holds, its registration
|
|
14106
|
+
* in the search index, and every version it accumulated.
|
|
14107
|
+
*
|
|
14108
|
+
* Two phases. The first frees the tuple and deregisters the variant, and is what makes the
|
|
14109
|
+
* combination of condition values immediately reusable — the second removes the version rows in
|
|
14110
|
+
* batches afterwards. A response arrives only once both have finished for this request, but the
|
|
14111
|
+
* tuple is reusable from the moment the first completes, whether or not the second did: a
|
|
14112
|
+
* variant with more versions than one transaction can carry is the ordinary case, not an edge
|
|
14113
|
+
* one. An interrupted delete is safe to send again; it picks up where it stopped.
|
|
14114
|
+
*
|
|
14115
|
+
* Nothing is archived. A variant an order or contract pins stops resolving, and hydration drops
|
|
14116
|
+
* the reference leniently rather than failing the read.
|
|
14117
|
+
*
|
|
14118
|
+
* This removes the **variant**, not one of its versions. To remove a single version, name it on
|
|
14119
|
+
* `…/variants/{variant_id}/versions/{valid_from}` — including the one currently in effect, which
|
|
14120
|
+
* deliberately has no "delete whichever is live" shorthand: that is exactly the write nobody
|
|
14121
|
+
* should be able to ask for without saying which version they meant.
|
|
14122
|
+
*
|
|
14123
|
+
*/
|
|
14124
|
+
'delete'(
|
|
14125
|
+
parameters?: Parameters<Paths.$DeleteConditionalVariant.PathParameters> | null,
|
|
14126
|
+
data?: any,
|
|
14127
|
+
config?: AxiosRequestConfig
|
|
14128
|
+
): OperationResponse<Paths.$DeleteConditionalVariant.Responses.$200>
|
|
14129
|
+
}
|
|
14130
|
+
['/v1/conditional-pricing/{slug}/entities/{entity_id}/variants/{variant_id}/versions']: {
|
|
14131
|
+
/**
|
|
14132
|
+
* $appendConditionalVariantVersion - $appendConditionalVariantVersion
|
|
14133
|
+
*
|
|
14134
|
+
* Appends a version to a variant: a new set of values taking effect at its own instant.
|
|
14135
|
+
*
|
|
14136
|
+
* This is how a price changes. No version carries an end date and nothing is superseded
|
|
14137
|
+
* explicitly — the version in effect at an instant is simply the one with the latest `valid_from`
|
|
14138
|
+
* at or before it, so appending a later version is the whole of "this is the new price from then
|
|
14139
|
+
* on". A version dated in the future is staged and excluded from resolution until its date.
|
|
14140
|
+
*
|
|
14141
|
+
* **A version is never refused for being late.** A `valid_from` in the past is written like any
|
|
14142
|
+
* other and answered with warnings in `warnings` naming what it moved — what resolves now, what a
|
|
14143
|
+
* past-dated read returns, or both. Correcting a price that took effect last week is ordinary
|
|
14144
|
+
* work; the alternative, deleting and recreating the variant, breaks every order and contract
|
|
14145
|
+
* pinning its id.
|
|
14146
|
+
*
|
|
14147
|
+
* What is refused is appending at a `valid_from` the variant already has: that write means either
|
|
14148
|
+
* "replace it" or "and also this", and only the caller knows which. The two operations both
|
|
14149
|
+
* exist, on the dated version path.
|
|
14150
|
+
*
|
|
14151
|
+
* The variant's `conditions` are its identity and are fixed at creation; they may be sent back
|
|
14152
|
+
* unchanged but never changed.
|
|
14153
|
+
*
|
|
14154
|
+
*/
|
|
14155
|
+
'post'(
|
|
14156
|
+
parameters?: Parameters<Paths.$AppendConditionalVariantVersion.PathParameters> | null,
|
|
14157
|
+
data?: Paths.$AppendConditionalVariantVersion.RequestBody,
|
|
14158
|
+
config?: AxiosRequestConfig
|
|
14159
|
+
): OperationResponse<Paths.$AppendConditionalVariantVersion.Responses.$201>
|
|
14160
|
+
}
|
|
14161
|
+
['/v1/conditional-pricing/{slug}/entities/{entity_id}/variants/{variant_id}/versions/{valid_from}']: {
|
|
14162
|
+
/**
|
|
14163
|
+
* $getConditionalVariantVersion - $getConditionalVariantVersion
|
|
14164
|
+
*
|
|
14165
|
+
* Returns one specific version of a variant, by the instant it takes effect — what a form editing
|
|
14166
|
+
* that version loads.
|
|
14167
|
+
*
|
|
14168
|
+
* Exact, never nearest: an instant the variant has no version at is a not-found rather than the
|
|
14169
|
+
* version that would be in effect at it. That question is the shorthand read's, or `:resolve`'s.
|
|
14170
|
+
*
|
|
14171
|
+
*/
|
|
14172
|
+
'get'(
|
|
14173
|
+
parameters?: Parameters<Paths.$GetConditionalVariantVersion.PathParameters> | null,
|
|
14174
|
+
data?: any,
|
|
14175
|
+
config?: AxiosRequestConfig
|
|
14176
|
+
): OperationResponse<Paths.$GetConditionalVariantVersion.Responses.$200>
|
|
14177
|
+
/**
|
|
14178
|
+
* $replaceConditionalVariantVersion - $replaceConditionalVariantVersion
|
|
14179
|
+
*
|
|
14180
|
+
* Replaces one version's values wholesale, addressed by its `valid_from`.
|
|
14181
|
+
*
|
|
14182
|
+
* Editable whatever its date, at both ends of the timeline: a scheduled version must stay
|
|
14183
|
+
* editable so a staged price can be corrected before it goes live rather than accumulating dead
|
|
14184
|
+
* versions beside it, and a past one must stay editable because correcting history is ordinary
|
|
14185
|
+
* work. Writing a superseded version is answered with a warning naming what a past-dated read now
|
|
14186
|
+
* returns; it is not refused.
|
|
14187
|
+
*
|
|
14188
|
+
* Attributes the variant may not override are ignored where the body carries them, and their
|
|
14189
|
+
* stored value is preserved rather than dropped.
|
|
14190
|
+
*
|
|
14191
|
+
*/
|
|
14192
|
+
'put'(
|
|
14193
|
+
parameters?: Parameters<Paths.$ReplaceConditionalVariantVersion.PathParameters> | null,
|
|
14194
|
+
data?: Paths.$ReplaceConditionalVariantVersion.RequestBody,
|
|
14195
|
+
config?: AxiosRequestConfig
|
|
14196
|
+
): OperationResponse<Paths.$ReplaceConditionalVariantVersion.Responses.$200>
|
|
14197
|
+
/**
|
|
14198
|
+
* $patchConditionalVariantVersion - $patchConditionalVariantVersion
|
|
14199
|
+
*
|
|
14200
|
+
* Changes only the fields it names on one version, addressed by its `valid_from`.
|
|
14201
|
+
*
|
|
14202
|
+
* Everything the body does not mention is left as stored. A partial update that tries to change a
|
|
14203
|
+
* pinned condition value is refused: condition values are immutable after a variant is created,
|
|
14204
|
+
* and this is the path that rule is most likely to be broken on by accident.
|
|
14205
|
+
*
|
|
14206
|
+
*/
|
|
14207
|
+
'patch'(
|
|
14208
|
+
parameters?: Parameters<Paths.$PatchConditionalVariantVersion.PathParameters> | null,
|
|
14209
|
+
data?: Paths.$PatchConditionalVariantVersion.RequestBody,
|
|
14210
|
+
config?: AxiosRequestConfig
|
|
14211
|
+
): OperationResponse<Paths.$PatchConditionalVariantVersion.Responses.$200>
|
|
14212
|
+
/**
|
|
14213
|
+
* $deleteConditionalVariantVersion - $deleteConditionalVariantVersion
|
|
14214
|
+
*
|
|
14215
|
+
* Removes one version of a variant.
|
|
14216
|
+
*
|
|
14217
|
+
* Withdrawing a scheduled adjustment is what this is for, and deleting a future version warns
|
|
14218
|
+
* about nothing — nothing that has resolved, or could have resolved, changes. Deleting a version
|
|
14219
|
+
* that has taken effect is allowed too and answered with a warning: it changes what a past-dated
|
|
14220
|
+
* read returns, and if it was the version in effect it changes what resolves now.
|
|
14221
|
+
*
|
|
14222
|
+
* **A variant's last remaining version cannot be deleted.** Such a variant would still hold its
|
|
14223
|
+
* condition tuple and still be selectable, and then resolve to nothing — which is a variant delete
|
|
14224
|
+
* wearing a version delete's clothes. Delete the variant instead; that frees the tuple too.
|
|
14225
|
+
*
|
|
14226
|
+
* The variant itself is untouched: it keeps its conditions, its tuple and its place in the index.
|
|
14227
|
+
*
|
|
14228
|
+
*/
|
|
14229
|
+
'delete'(
|
|
14230
|
+
parameters?: Parameters<Paths.$DeleteConditionalVariantVersion.QueryParameters & Paths.$DeleteConditionalVariantVersion.PathParameters> | null,
|
|
14231
|
+
data?: any,
|
|
14232
|
+
config?: AxiosRequestConfig
|
|
14233
|
+
): OperationResponse<Paths.$DeleteConditionalVariantVersion.Responses.$200>
|
|
14234
|
+
}
|
|
12124
14235
|
}
|
|
12125
14236
|
|
|
12126
14237
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -12129,6 +14240,7 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
12129
14240
|
type AdditionalProviderData = Components.Schemas.AdditionalProviderData;
|
|
12130
14241
|
type Address = Components.Schemas.Address;
|
|
12131
14242
|
type Amounts = Components.Schemas.Amounts;
|
|
14243
|
+
type AppendVersionRequest = Components.Schemas.AppendVersionRequest;
|
|
12132
14244
|
type AvailabilityCheckParams = Components.Schemas.AvailabilityCheckParams;
|
|
12133
14245
|
type AvailabilityFilters = Components.Schemas.AvailabilityFilters;
|
|
12134
14246
|
type AvailabilityLocation = Components.Schemas.AvailabilityLocation;
|
|
@@ -12165,15 +14277,24 @@ type ComputePriceResult = Components.Schemas.ComputePriceResult;
|
|
|
12165
14277
|
type ComputedBasePrice = Components.Schemas.ComputedBasePrice;
|
|
12166
14278
|
type ComputedPriceBreakdown = Components.Schemas.ComputedPriceBreakdown;
|
|
12167
14279
|
type ComputedPriceComponents = Components.Schemas.ComputedPriceComponents;
|
|
14280
|
+
type ConditionDefinition = Components.Schemas.ConditionDefinition;
|
|
14281
|
+
type ConditionSet = Components.Schemas.ConditionSet;
|
|
14282
|
+
type ConditionSetCatalog = Components.Schemas.ConditionSetCatalog;
|
|
14283
|
+
type ConditionType = Components.Schemas.ConditionType;
|
|
14284
|
+
type ConditionalEntitySlug = Components.Schemas.ConditionalEntitySlug;
|
|
12168
14285
|
type ConditionalPricingError = Components.Schemas.ConditionalPricingError;
|
|
12169
14286
|
type ConditionalPricingErrorCode = Components.Schemas.ConditionalPricingErrorCode;
|
|
12170
14287
|
type ConsumptionTypeGetAg = Components.Schemas.ConsumptionTypeGetAg;
|
|
12171
14288
|
type Coupon = Components.Schemas.Coupon;
|
|
12172
14289
|
type CouponItem = Components.Schemas.CouponItem;
|
|
12173
14290
|
type CouponWithoutPromoCodes = Components.Schemas.CouponWithoutPromoCodes;
|
|
14291
|
+
type CreateVariantRequest = Components.Schemas.CreateVariantRequest;
|
|
14292
|
+
type CreatedVariant = Components.Schemas.CreatedVariant;
|
|
12174
14293
|
type Currency = Components.Schemas.Currency;
|
|
12175
14294
|
type CustomContext = Components.Schemas.CustomContext;
|
|
12176
14295
|
type Customer = Components.Schemas.Customer;
|
|
14296
|
+
type DeletedVariant = Components.Schemas.DeletedVariant;
|
|
14297
|
+
type DeletedVariantVersion = Components.Schemas.DeletedVariantVersion;
|
|
12177
14298
|
type DiscountAmounts = Components.Schemas.DiscountAmounts;
|
|
12178
14299
|
type DynamicTariffInterval = Components.Schemas.DynamicTariffInterval;
|
|
12179
14300
|
type DynamicTariffMode = Components.Schemas.DynamicTariffMode;
|
|
@@ -12217,7 +14338,9 @@ type OrderPayload = Components.Schemas.OrderPayload;
|
|
|
12217
14338
|
type OrderRelation = Components.Schemas.OrderRelation;
|
|
12218
14339
|
type OrderSource = Components.Schemas.OrderSource;
|
|
12219
14340
|
type OrderStatus = Components.Schemas.OrderStatus;
|
|
14341
|
+
type PatchVersionRequest = Components.Schemas.PatchVersionRequest;
|
|
12220
14342
|
type PaymentMethod = Components.Schemas.PaymentMethod;
|
|
14343
|
+
type PinnedConditions = Components.Schemas.PinnedConditions;
|
|
12221
14344
|
type PortalContext = Components.Schemas.PortalContext;
|
|
12222
14345
|
type PowerMarketAreaDetails = Components.Schemas.PowerMarketAreaDetails;
|
|
12223
14346
|
type PowerMeterType = Components.Schemas.PowerMeterType;
|
|
@@ -12251,6 +14374,12 @@ type RecurrenceAmount = Components.Schemas.RecurrenceAmount;
|
|
|
12251
14374
|
type RecurrenceAmountDto = Components.Schemas.RecurrenceAmountDto;
|
|
12252
14375
|
type RecurrenceAmountWithTax = Components.Schemas.RecurrenceAmountWithTax;
|
|
12253
14376
|
type RedeemedPromo = Components.Schemas.RedeemedPromo;
|
|
14377
|
+
type ReplaceVersionRequest = Components.Schemas.ReplaceVersionRequest;
|
|
14378
|
+
type ResolveConditionalEntityRequest = Components.Schemas.ResolveConditionalEntityRequest;
|
|
14379
|
+
type ResolveContext = Components.Schemas.ResolveContext;
|
|
14380
|
+
type ResolveOptions = Components.Schemas.ResolveOptions;
|
|
14381
|
+
type ResolvedVariant = Components.Schemas.ResolvedVariant;
|
|
14382
|
+
type ResolvedVariants = Components.Schemas.ResolvedVariants;
|
|
12254
14383
|
type SalesTax = Components.Schemas.SalesTax;
|
|
12255
14384
|
type SaveIntegrationCredentialsParams = Components.Schemas.SaveIntegrationCredentialsParams;
|
|
12256
14385
|
type SearchExternalCatalogParams = Components.Schemas.SearchExternalCatalogParams;
|
|
@@ -12277,5 +14406,11 @@ type TotalDetails = Components.Schemas.TotalDetails;
|
|
|
12277
14406
|
type TypeGetAg = Components.Schemas.TypeGetAg;
|
|
12278
14407
|
type ValidateAvailabilityFileError = Components.Schemas.ValidateAvailabilityFileError;
|
|
12279
14408
|
type ValidateAvailabilityFileResult = Components.Schemas.ValidateAvailabilityFileResult;
|
|
14409
|
+
type VariantConditions = Components.Schemas.VariantConditions;
|
|
14410
|
+
type VariantValues = Components.Schemas.VariantValues;
|
|
14411
|
+
type VariantVersion = Components.Schemas.VariantVersion;
|
|
14412
|
+
type VariantWriteWarning = Components.Schemas.VariantWriteWarning;
|
|
14413
|
+
type VersionWriteWarning = Components.Schemas.VersionWriteWarning;
|
|
14414
|
+
type WrittenVariantVersion = Components.Schemas.WrittenVariantVersion;
|
|
12280
14415
|
|
|
12281
|
-
export { type
|
|
14416
|
+
export { type Coupon as $, type AdditionalProviderData as A, type BaseCompositePrice as B, type Client as C, type CheckoutCart as D, type CheckoutCartResult as E, type CheckoutMode as F, type CompositePrice as G, type CompositePriceItem as H, type CompositePriceItemDto as I, type ComputePriceParams as J, type ComputePriceParamsBase as K, type ComputePriceParamsGas as L, type ComputePriceParamsPower as M, type ComputePriceResult as N, type OperationMethods as O, Paths as P, type ComputedBasePrice as Q, type ComputedPriceBreakdown as R, type ComputedPriceComponents as S, type ConditionDefinition as T, type ConditionSet as U, type ConditionSetCatalog as V, type ConditionType as W, type ConditionalEntitySlug as X, type ConditionalPricingError as Y, type ConditionalPricingErrorCode as Z, type ConsumptionTypeGetAg as _, Components as a, type PriceGetAg as a$, type CouponItem as a0, type CouponWithoutPromoCodes as a1, type CreateVariantRequest as a2, type CreatedVariant as a3, type Currency as a4, type CustomContext as a5, type Customer as a6, type DeletedVariant as a7, type DeletedVariantVersion as a8, type DiscountAmounts as a9, type JourneyContext as aA, type MarketParticipant as aB, type MarkupPricingModel as aC, type MetaData as aD, type NonHydratedCompositePrice as aE, type OAuthCredentials as aF, type OAuthIntegration as aG, type Offer as aH, type OfferHighlightConfig as aI, type Opportunity as aJ, type OpportunitySource as aK, type Order as aL, type OrderPayload as aM, type OrderRelation as aN, type OrderSource as aO, type OrderStatus as aP, type PatchVersionRequest as aQ, type PaymentMethod as aR, type PinnedConditions as aS, type PortalContext as aT, type PowerMarketAreaDetails as aU, type PowerMeterType as aV, type Price as aW, type PriceAmounts as aX, type PriceComponentRelation as aY, type PriceConditions as aZ, type PriceDynamicTariff as a_, type DynamicTariffInterval as aa, type DynamicTariffMode as ab, type EntityId as ac, type EntityItem as ad, type EntityRelation as ae, type Error as af, type ExternalCatalogConfigurationRequest as ag, type ExternalCatalogCustomRequest as ah, type ExternalCatalogItem as ai, type ExternalCatalogJourneyRequest as aj, type ExternalCatalogPortalRequest as ak, type ExternalCatalogRequest as al, type ExternalFeeMapping as am, type ExternalFeeMappings as an, type ExternalFeeMetadata as ao, type ExternalLocationMetadata as ap, type ExternalPriceMetadata as aq, type File as ar, type GasConcessionType as as, type GasMarketAreaDetails as at, type HistoricMarketPriceRecord as au, type HistoricMarketPricesResult as av, type HydratedCompositePrice as aw, type IntegrationAuthCredentials as ax, type IntegrationCredentialsResult as ay, type IntegrationId as az, type PathsDictionary as b, type PriceInputMapping as b0, type PriceInputMappings as b1, type PriceItem as b2, type PriceItemDto as b3, type PriceItemDtoUnion as b4, type PriceItems as b5, type PriceItemsDto as b6, type PriceTier as b7, type PriceTierDisplayMode as b8, type PricingDetails as b9, type SearchProvidersResult as bA, type SearchStreetsParams as bB, type SearchStreetsResult as bC, type SignatureMeta as bD, type SpotMarketBiddingZone as bE, type SpotMarketDataFrequency as bF, type SpotMarketType as bG, type Street as bH, type TariffTypeGetAg as bI, type Tax as bJ, type TaxAmount as bK, type TaxAmountBreakdown as bL, type TaxAmountDto as bM, type TaxBreakdownInfo as bN, type TaxItem as bO, type TierDetails as bP, type TotalDetails as bQ, type TypeGetAg as bR, type ValidateAvailabilityFileError as bS, type ValidateAvailabilityFileResult as bT, type VariantConditions as bU, type VariantValues as bV, type VariantVersion as bW, type VariantWriteWarning as bX, type VersionWriteWarning as bY, type WrittenVariantVersion as bZ, type PricingDetailsResponse as ba, type PricingModel as bb, type Product as bc, type ProductCategory as bd, type ProductRecommendation as be, type ProductRecommendationResponse as bf, type ProductRecommendationSearch as bg, type PromoCode as bh, type PromoCodeValidationResponse as bi, type Provider as bj, type RecurrenceAmount as bk, type RecurrenceAmountDto as bl, type RecurrenceAmountWithTax as bm, type RedeemedPromo as bn, type ReplaceVersionRequest as bo, type ResolveConditionalEntityRequest as bp, type ResolveContext as bq, type ResolveOptions as br, type ResolvedVariant as bs, type ResolvedVariants as bt, type SalesTax as bu, type SaveIntegrationCredentialsParams as bv, type SearchExternalCatalogParams as bw, type SearchExternalCatalogRecommendationsResult as bx, type SearchExternalCatalogResult as by, type SearchProvidersParams as bz, type Address as c, type Amounts as d, type AppendVersionRequest as e, type AvailabilityCheckParams as f, type AvailabilityFilters as g, type AvailabilityLocation as h, type AvailabilityResult as i, type AverageMarketPriceRecord as j, type AverageMarketPriceResult as k, type BaseCouponCommon as l, type BaseMarketPriceRecord as m, type BasePriceItem as n, type BasePriceItemCommon as o, type BasePriceItemDto as p, type BasicAuthCredentials as q, type BasicAuthIntegration as r, type BillingPeriod as s, type CartDto as t, type CashbackAmount as u, type CashbackAmounts as v, type CashbackPeriod as w, type CatalogFieldsParam as x, type CatalogSearch as y, type CatalogSearchResult as z };
|