Class ActionCatalog

Action API object

Hierarchy

  • ActionCatalog

Implements

Constructors

constructor

Properties

catalog_id product_retailer_id? sections?

Accessors

_type

Constructors

constructor

  • Builds a catalog component for an Interactive message

    Parameters

    • catalog_id: string

      The catalog id

    • Rest ...products: [Product] | AtLeastOne<ProductSection>

      The products to add to the catalog. It can be a single Product object, or a list of ProductSections.

    Returns ActionCatalog

    Throws

    If products is a product list and more than 10 sections are provided

    Throws

    If products is a product list with more than 1 section and at least one section is missing a title

Properties

Readonly catalog_id

catalog_id: string

The id of the catalog from where to get the products

Optional Readonly product_retailer_id

product_retailer_id?: string

The product to be added to the catalog

Optional Readonly sections

sections?: ProductSection[]

The section to be added to the catalog

Accessors

_type

  • get _type(): "product" | "product_list"

  • Returns "product" | "product_list"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc