braze-api/esm/catalogs/synchronous/types.d.ts

Track users, send messages, export data, and more with Braze API.

import type { RequestBody, ServerResponse } from '../../common/request';
/**
 * Response body for catalog list.
 *
 * {@link https://www.braze.com/docs/api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/}
 */
export interface CatalogListResponse extends ServerResponse {
    catalogs: {
        description: string;
        fields: {
            name: string;
            type: string;
        }[];
    }[];
}
/**
 * Request body for catalog list items.
 *
 * {@link https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/}
 */
export interface CatalogListItemsBody {
    catalog_name: string;
    max_pages?: number;
}
export type CatalogListItem<T extends RequestBody = Record<string, unknown>> = {
    id: string;
} & T;
/**
 * Response body for catalog list items.
 *
 * {@link https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/}
 */
export interface CatalogListItemsResponse<T extends CatalogListItem = CatalogListItem> extends ServerResponse {
    items: T[];
}
/**
 * Request body for catalog list items.
 *
 * {@link https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/}
 */
export interface CatalogListItemBody {
    catalog_name: string;
    item_id: string;
}
/**
 * Response body for catalog list items.
 *
 * {@link https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/}
 */
export interface CatalogListItemResponse<T extends CatalogListItem = CatalogListItem> extends ServerResponse {
    items: [T];
}
//# sourceMappingURL=types.d.ts.map