braze-api/cjs/templates/content_blocks/types.d.ts

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

import type { ServerResponse } from '../../common/request';
/**
 * Request body for content block list.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/}
 */
export interface ContentBlockListBody {
    modified_after?: string;
    modified_before?: string;
    limit?: number;
    offset?: number;
}
/**
 * Response body for content block list.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/}
 */
export interface ContentBlockListResponse extends ServerResponse {
    count: number;
    content_blocks: {
        content_block_id: string;
        name: string;
        content_type: string;
        liquid_tag: string;
        inclusion_count: number;
        created_at: string;
        last_edited: string;
        tags: string[];
    }[];
}
/**
 * Request body for content block.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/}
 */
export interface ContentBlockBody {
    content_block_id: string;
    include_inclusion_data?: boolean;
}
/**
 * Response body for content block.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/}
 */
export interface ContentBlockResponse extends ServerResponse {
    content_block_id: string;
    name: string;
    content: string;
    description: string;
    content_type: string;
    tags: string[];
    created_at: string;
    last_edited: string;
    inclusion_count: number;
    inclusion_data: string[];
}
/**
 * Request body for create content block.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block/}
 */
export interface CreateContentBlockBody {
    name: string;
    description?: string;
    content: string;
    state?: 'active' | 'draft';
    tags?: string[];
}
/**
 * Request body for update content block.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_update_content_block/}
 */
export interface UpdateContentBlockBody extends Partial<CreateContentBlockBody> {
    content_block_id: string;
}
/**
 * Response body for create/update content block.
 *
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block/}
 * {@link https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_update_content_block/}
 */
export interface PostContentBlockResponse extends ServerResponse {
    content_block_id: string;
    liquid_tag: string;
    created_at: string;
    message: 'success';
}
//# sourceMappingURL=types.d.ts.map