API Reference › Globals › RapiCatalog

Interface: RapiCatalog

Hierarchy

• RapiJson

  ↳ RapiCatalog

Indexable

• [ key: string]: any

Index

Properties

• rapi_path
• active
• allItems
• allTags
• brandIcon
• branded
• components
• cover
• created
• description
• externalIdentifier
• featured
• featuredImage
• free
• hidden
• hiddenByTenant
• hiddenByUser
• id
• isLocally
• items
• links
• materials
• name
• orderable
• public
• purchased
• retailers
• rootTags
• sort
• tags
• tenant
• tenantIsOwner
• updated

Properties

Optional rapi_path

• **rapi_path**? : string

Inherited from RapiJson.rapi_path

Defined in packages/typings/rapi-types.ts:35

---

active

• active: boolean

Defined in packages/typings/rapi-types.ts:155

---

allItems

• allItems: RapiItem[]

Defined in packages/typings/rapi-types.ts:161

---

allTags

• allTags: RapiTag[]

Defined in packages/typings/rapi-types.ts:165

---

brandIcon

• brandIcon: string

Defined in packages/typings/rapi-types.ts:142

---

branded

• branded: boolean

Defined in packages/typings/rapi-types.ts:157

---

components

• components: RapiComponent[]

Defined in packages/typings/rapi-types.ts:162

---

cover

• cover: string

Defined in packages/typings/rapi-types.ts:141

---

created

• created: string

Defined in packages/typings/rapi-types.ts:148

---

description

• description: string

Defined in packages/typings/rapi-types.ts:143

---

externalIdentifier

• externalIdentifier: string

Defined in packages/typings/rapi-types.ts:140

---

featured

• featured: boolean

Defined in packages/typings/rapi-types.ts:146

---

featuredImage

• featuredImage: string

Defined in packages/typings/rapi-types.ts:139

---

free

• free: boolean

Defined in packages/typings/rapi-types.ts:144

---

hidden

• hidden: boolean

Defined in packages/typings/rapi-types.ts:150

---

hiddenByTenant

• hiddenByTenant: boolean

Defined in packages/typings/rapi-types.ts:152

---

hiddenByUser

• hiddenByUser: boolean

Defined in packages/typings/rapi-types.ts:151

---

id

• id: RapiId

Overrides RapiJson.id

Defined in packages/typings/rapi-types.ts:137

---

Optional isLocally

• isLocally? : boolean

Inherited from RapiJson.isLocally

Defined in packages/typings/rapi-types.ts:34

---

items

• items: RapiItem[]

Defined in packages/typings/rapi-types.ts:160

---

Optional links

• links? : LinksCollection

Inherited from RapiJson.links

Defined in packages/typings/rapi-types.ts:39

---

materials

• materials: RapiMaterial[]

Defined in packages/typings/rapi-types.ts:163

---

name

• name: string

Defined in packages/typings/rapi-types.ts:138

---

orderable

• orderable: boolean

Defined in packages/typings/rapi-types.ts:154

---

public

• public: boolean

Defined in packages/typings/rapi-types.ts:145

---

purchased

• purchased: boolean

Defined in packages/typings/rapi-types.ts:156

---

retailers

• retailers: RapiRetailer[]

Defined in packages/typings/rapi-types.ts:167

---

rootTags

• rootTags: RapiTag[]

Defined in packages/typings/rapi-types.ts:166

---

sort

• sort: number

Defined in packages/typings/rapi-types.ts:147

---

tags

• tags: RapiId[]

Defined in packages/typings/rapi-types.ts:164

---

tenant

• tenant: RapiTenant

Defined in packages/typings/rapi-types.ts:159

---

tenantIsOwner

• tenantIsOwner: boolean

Defined in packages/typings/rapi-types.ts:153

---

updated

• updated: string

Defined in packages/typings/rapi-types.ts:149