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

Interface: CipReportDefinition

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

Curated CIP report definition.

Properties

buildSql()

buildSql: (params) => string

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

Parameters

params

Record<string, string>

Returns

string

---

category

category: string

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

---

description

description: string

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

---

name

name: string

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

---

parameters

parameters: CipReportParamDefinition[]

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

---

tablesUsed?

optional tablesUsed: string[]

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

Optional list of warehouse tables the report reads, for discoverability in --describe output and the report listing command. Does not affect SQL.