diff --git a/404.html b/404.html index 94677ea56..b66142992 100644 --- a/404.html +++ b/404.html @@ -1,4 +1,4 @@ -braze-api
+braze-api

Returns Promise<{
    dispatch_id: string;
    message: string;
}>

+
  • Defined in Braze.ts:41
  • canvas: {
        trigger: {
            schedule: {
                create: ((body) => Promise<CanvasTriggerScheduleCreatResponse>);
                delete: ((body) => Promise<ServerResponse>);
                update: ((body) => Promise<ServerResponse>);
            };
            send: ((body) => Promise<{
                dispatch_id: string;
                message: string;
            }>);
        };
    } = ...
    @@ -219,7 +219,7 @@

    Parameters

    body: CanvasTriggerSendObject

    Returns Promise<{
        dispatch_id: string;
        message: string;
    }>

    +
  • Defined in Braze.ts:59
  • catalogs: {
        synchronous: {
            item: (<T>(body) => Promise<CatalogListItemResponse<T>>);
            items: (<T>(body) => AsyncGenerator<T, any, unknown>);
            list: (() => Promise<CatalogListResponse>);
        };
    } = ...
    @@ -274,7 +274,7 @@
    list

    Returns Promise<CatalogListResponse>

    +
  • Defined in Braze.ts:77
  • email: {
        blacklist: ((body) => Promise<ServerResponse>);
        bounce: {
            remove: ((body) => Promise<ServerResponse>);
        };
        spam: {
            remove: ((body) => Promise<ServerResponse>);
        };
    } = ...
    @@ -327,7 +327,7 @@

    Parameters

    body: EmailSpamRemoveObject

    Returns Promise<ServerResponse>

    +
  • Defined in Braze.ts:89
  • messages: {
        schedule: {
            create: ((body) => Promise<{
                dispatch_id: string;
                message: string;
                schedule_id: string;
            }>);
            delete: ((body) => Promise<ServerResponse>);
            update: ((body) => Promise<ServerResponse>);
        };
        scheduled_broadcasts: ((body) => Promise<ScheduledBroadcastsResponse>);
        send: ((body) => Promise<{
            dispatch_id: string;
            message: string;
        }>);
    } = ...
    @@ -403,7 +403,7 @@

    Parameters

    body: MessagesSendObject

    Returns Promise<{
        dispatch_id: string;
        message: string;
    }>

    +
  • Defined in Braze.ts:104
  • sends: {
        id: {
            create: ((body) => Promise<{
                message: string;
                send_id: string;
            }>);
        };
    } = ...
    @@ -427,7 +427,7 @@

    Parameters

    body: SendsIdCreateObject

    Returns Promise<{
        message: string;
        send_id: string;
    }>

    +
  • Defined in Braze.ts:122
  • subscription: {
        status: {
            get: ((body) => Promise<{
                message: string;
                status: Record<string, "Subscribed" | "Unsubscribed" | "Unknown">;
            }>);
            set: ((body) => Promise<{
                message: string;
            }>);
        };
        user: {
            status: ((body) => Promise<ServerResponse>);
        };
    } = ...
    @@ -480,7 +480,7 @@

    Parameters

    body: SubscriptionUserStatusObject

    Returns Promise<ServerResponse>

    +
  • Defined in Braze.ts:129
  • templates: {
        content_blocks: {
            get: ((body) => Promise<ContentBlockResponse>);
            list: ((body) => Promise<ContentBlockListResponse>);
        };
    } = ...
    @@ -517,7 +517,7 @@

    Parameters

    body: ContentBlockListBody

    Returns Promise<ContentBlockListResponse>

    +
  • Defined in Braze.ts:144
  • transactional: {
        v1: {
            campaigns: {
                send: ((campaignId, body) => Promise<CampaignSendResponse>);
            };
        };
    } = ...
    @@ -546,7 +546,7 @@
    campaignId: body: TransactionalV1CampaignsSendObject

    Returns Promise<CampaignSendResponse>

    +
  • Defined in Braze.ts:153
  • users: {
        alias: {
            new: ((body) => Promise<ServerResponse>);
        };
        delete: ((body) => Promise<UsersDeleteResponse>);
        export: {
            global_control_group: ((body) => Promise<UsersExportGlobalControlGroupResponse>);
            ids: ((body) => Promise<UsersExportIdsResponse>);
            segment: ((body) => Promise<UsersExportSegmentResponse>);
        };
        external_ids: {
            remove: ((body) => Promise<{
                message: string;
                removal_errors: string[];
                removed_ids: string[];
            }>);
            rename: ((body) => Promise<{
                external_ids: string[];
                message: string;
                rename_errors: string[];
            }>);
        };
        identify: ((body) => Promise<ServerResponse>);
        merge: ((body) => Promise<ServerResponse>);
        track: ((body, bulk?) => Promise<{
            attributes_processed?: number;
            errors?: object[];
            events_processed?: number;
            message: string;
            purchases_processed?: number;
        }>);
    } = ...
    @@ -695,7 +695,7 @@
    body: Optional bulk: boolean

    Returns Promise<{
        attributes_processed?: number;
        errors?: object[];
        events_processed?: number;
        message: string;
        purchases_processed?: number;
    }>

    +
  • Defined in Braze.ts:164
  • v2: {
        subscription: {
            status: {
                set: ((body) => Promise<{
                    message: string;
                }>);
            };
        };
    } = ...
    @@ -722,7 +722,7 @@

    Parameters

    body: V2SubscriptionStatusSetObject

    Returns Promise<{
        message: string;
    }>

    +
  • Defined in Braze.ts:198