@salesforce/b2c-tooling-sdk / operations/cip / CipReportParamDefinition

Interface: CipReportParamDefinition

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:15

Parameter contract for a curated CIP report.

Properties

default?

optional default: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:39

Default value applied when the parameter is omitted. For multiple parameters this may be a comma-separated string. Defaults are injected before validation so a report can rely on the value being present.

---

description

description: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:17

---

max?

optional max: number

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:21

---

min?

optional min: number

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:20

---

multiple?

optional multiple: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:33

When true, the parameter accepts multiple comma-separated values, suitable for a SQL IN (...) clause. Each value is validated against options when both are set.

---

name

name: string

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:16

---

options?

optional options: string[]

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:27

Allowed values for an enum-style parameter (for example ['4xx', '5xx']). When set, CipReportParamType should be string and the value is validated against this set before the report's SQL builder runs.

---

required?

optional required: boolean

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:19

---

type

type: CipReportParamType

Defined in: packages/b2c-tooling-sdk/src/operations/cip/types.ts:18