diff --git a/404.html b/404.html index 62f16b9cf..7e4be12a4 100644 --- a/404.html +++ b/404.html @@ -1,4 +1,4 @@ -braze-api
+braze-api
+
  • CampaignSendResponse
    • +
  • CampaignsListParameters
    • +
  • CampaignsListResponse
    • +
  • CampaignsTriggerScheduleCreateObject
    • +
  • CampaignsTriggerScheduleCreateResponse
    • +
  • CampaignsTriggerScheduleDeleteObject
    • +
  • CampaignsTriggerScheduleUpdateObject
    • +
  • CampaignsTriggerSendObject
    • +
  • CanvasTriggerScheduleCreatResponse
    • +
  • CanvasTriggerScheduleCreateObject
    • +
  • CanvasTriggerScheduleDeleteObject
    • +
  • CanvasTriggerScheduleUpdateObject
    • +
  • CanvasTriggerSendObject
    • +
  • CatalogListItemBody
    • +
  • CatalogListItemResponse
    • +
  • CatalogListItemsBody
    • +
  • CatalogListItemsResponse
    • +
  • CatalogListResponse
    • +
  • ConnectedAudienceObject
    • +
  • ContentBlockBody
    • +
  • ContentBlockListBody
    • +
  • ContentBlockListResponse
    • +
  • ContentBlockResponse
    • +
  • CreateEmailTemplateBody
    • +
  • EmailBlacklistObject
    • +
  • EmailBounceRemoveObject
    • +
  • EmailSpamRemoveObject
    • +
  • EmailTemplateBody
    • +
  • EmailTemplateListBody
    • +
  • EmailTemplateListResponse
    • +
  • EmailTemplateResponse
    • +
  • MessagesObject
    • +
  • MessagesScheduleCreateObject
    • +
  • MessagesScheduleDeleteObject
    • +
  • MessagesScheduleUpdateObject
    • +
  • MessagesSendObject
    • +
  • PostEmailTemplateResponse
    • +
  • ScheduleObject
    • +
  • ScheduledBroadcastsObject
    • +
  • ScheduledBroadcastsResponse
    • +
  • SendsIdCreateObject
    • +
  • SubscriptionStatusGetObject
    • +
  • SubscriptionUserStatusObject
    • +
  • SubscriptionUserStatusResponse
    • +
  • TransactionalV1CampaignsSendObject
    • +
  • UpdateEmailTemplateBody
    • +
  • UserAlias
    • +
  • UsersAliasObject
    • +
  • UsersDeleteObject
    • +
  • UsersDeleteResponse
    • +
  • UsersExportGlobalControlGroupObject
    • +
  • UsersExportGlobalControlGroupResponse
    • +
  • UsersExportIdsObject
    • +
  • UsersExportIdsResponse
    • +
  • UsersExportSegmentObject
    • +
  • UsersExportSegmentResponse
    • +
  • UsersExternalIdsRemoveObject
    • +
  • UsersExternalIdsRenameObject
    • +
  • UsersIdentifyObject
    • +
  • UsersMergeObject
    • +
  • UsersTrackObject
    • +
  • V2SubscriptionStatusSetObject
    • +
  • Attributes
    • +
  • CatalogListItem
    • +
  • Properties
    • +
  • SubscriptionStatusSetObject
    • +
  • TriggerProperties

    • Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/Braze.html b/classes/Braze.html index 395dbea7b..21b0232bd 100644 --- a/classes/Braze.html +++ b/classes/Braze.html @@ -1,4 +1,4 @@ -Braze | braze-api
    +Braze | braze-api
    +
  • Defined in Braze.ts:22

    • Private Readonly apiUrl

    apiUrl: string
    @@ -87,7 +87,7 @@

    Private

    +
  • Defined in Braze.ts:17

    • campaigns

    campaigns: {
        list: ((parameters?) => Promise<CampaignsListResponse>);
        trigger: {
            schedule: {
                create: ((body) => Promise<CampaignsTriggerScheduleCreateResponse>);
                delete: ((body) => Promise<ServerResponse>);
                update: ((body) => Promise<ServerResponse>);
            };
            send: ((body) => Promise<{
                dispatch_id: string;
                message: string;
            }>);
        };
    } = ...
    @@ -181,7 +181,7 @@
    body: Returns Promise<{
        dispatch_id: string;
        message: string;
    }>
    +
  • Defined in Braze.ts:42

    • canvas

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

    • catalogs

    catalogs: {
        synchronous: {
            item: (<T>(body) => Promise<CatalogListItemResponse<T>>);
            items: (<T>(body) => AsyncGenerator<T, any, unknown>);
            list: (() => Promise<CatalogListResponse>);
        };
    } = ...
    @@ -326,7 +326,7 @@

    Returns Promise<

    +
  • Defined in Braze.ts:120

    • email

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

    • messages

    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;
        }>);
    } = ...
    @@ -485,7 +485,7 @@

    Returns Promise<

    +
  • Defined in Braze.ts:182

    • sends

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

    • subscription

    subscription: {
        status: {
            get: ((body) => Promise<{
                message: string;
                status: Record<string, "Subscribed" | "Unsubscribed" | "Unknown">;
            }>);
            set: ((body) => Promise<{
                message: string;
            }>);
        };
        user: {
            status: ((body) => Promise<SubscriptionUserStatusResponse>);
        };
    } = ...
    @@ -577,7 +577,7 @@

    Returns Promise<

    +
  • Defined in Braze.ts:235

    • templates

    templates: {
        content_blocks: {
            get: ((body) => Promise<ContentBlockResponse>);
            list: ((body) => Promise<ContentBlockListResponse>);
        };
        email_templates: {
            create: ((body) => Promise<PostEmailTemplateResponse>);
            get: ((body) => Promise<EmailTemplateResponse>);
            list: ((body) => Promise<EmailTemplateListResponse>);
            update: ((body) => Promise<PostEmailTemplateResponse>);
        };
    } = ...
    @@ -690,7 +690,7 @@

    Returns Promise<

    +
  • Defined in Braze.ts:265

    • transactional

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

    • users

    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;
        }>);
    } = ...
    @@ -907,7 +907,7 @@

    Returns Promise<

    +
  • Defined in Braze.ts:332

    • v2

    v2: {
        subscription: {
            status: {
                set: ((body) => Promise<{
                    message: string;
                }>);
            };
        };
    } = ...
    @@ -940,7 +940,7 @@
    body: Returns Promise<{
        message: string;
    }>
    +
  • Defined in Braze.ts:413
    • diff --git a/index.html b/index.html index 23cd4e29c..821ab7546 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -braze-api
    +braze-api
    diff --git a/interfaces/CampaignsListParameters.html b/interfaces/CampaignsListParameters.html index 0f84e1930..bd7964578 100644 --- a/interfaces/CampaignsListParameters.html +++ b/interfaces/CampaignsListParameters.html @@ -1,4 +1,4 @@ -CampaignsListParameters | braze-api
    +CampaignsListParameters | braze-api
    +
  • Defined in campaigns/types.ts:14
    • diff --git a/interfaces/CampaignsListResponse.html b/interfaces/CampaignsListResponse.html index b054b532c..11331f256 100644 --- a/interfaces/CampaignsListResponse.html +++ b/interfaces/CampaignsListResponse.html @@ -1,4 +1,4 @@ -CampaignsListResponse | braze-api
    +CampaignsListResponse | braze-api
    +
  • Defined in campaigns/types.ts:24

    • Optional errors

    errors?: string[]
    +
  • Defined in common/request/request.ts:13

    • message

    message: string
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/CampaignsTriggerScheduleCreateObject.html b/interfaces/CampaignsTriggerScheduleCreateObject.html index 6acc9db52..7dd4e0561 100644 --- a/interfaces/CampaignsTriggerScheduleCreateObject.html +++ b/interfaces/CampaignsTriggerScheduleCreateObject.html @@ -1,4 +1,4 @@ -CampaignsTriggerScheduleCreateObject | braze-api
    +CampaignsTriggerScheduleCreateObject | braze-api
    +
  • Defined in campaigns/trigger/types.ts:18

    • Optional broadcast

    broadcast?: boolean
    +
  • Defined in campaigns/trigger/types.ts:17

    • campaign_id

    campaign_id: string
    +
  • Defined in campaigns/trigger/types.ts:14

    • Optional recipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]
    +
  • Defined in campaigns/trigger/types.ts:19

    • schedule

    schedule: ScheduleObject
    +
  • Defined in campaigns/trigger/schedule/types.ts:11

    • Optional send_id

    send_id?: string
    +
  • Defined in campaigns/trigger/types.ts:15

    • Optional trigger_properties

    trigger_properties?: object
    +
  • Defined in campaigns/trigger/types.ts:16
    • diff --git a/interfaces/CampaignsTriggerScheduleCreateResponse.html b/interfaces/CampaignsTriggerScheduleCreateResponse.html index fcb38cfed..18f0e750e 100644 --- a/interfaces/CampaignsTriggerScheduleCreateResponse.html +++ b/interfaces/CampaignsTriggerScheduleCreateResponse.html @@ -1,4 +1,4 @@ -CampaignsTriggerScheduleCreateResponse | braze-api
    +CampaignsTriggerScheduleCreateResponse | braze-api
    +
  • Defined in campaigns/trigger/schedule/types.ts:20
    • diff --git a/interfaces/CampaignsTriggerScheduleDeleteObject.html b/interfaces/CampaignsTriggerScheduleDeleteObject.html index ab85c19bd..3aa7cc0b7 100644 --- a/interfaces/CampaignsTriggerScheduleDeleteObject.html +++ b/interfaces/CampaignsTriggerScheduleDeleteObject.html @@ -1,4 +1,4 @@ -CampaignsTriggerScheduleDeleteObject | braze-api
    +CampaignsTriggerScheduleDeleteObject | braze-api
    +
  • Defined in campaigns/trigger/schedule/types.ts:30
    • diff --git a/interfaces/CampaignsTriggerScheduleUpdateObject.html b/interfaces/CampaignsTriggerScheduleUpdateObject.html index b8d9c37bc..98c45fc8b 100644 --- a/interfaces/CampaignsTriggerScheduleUpdateObject.html +++ b/interfaces/CampaignsTriggerScheduleUpdateObject.html @@ -1,4 +1,4 @@ -CampaignsTriggerScheduleUpdateObject | braze-api
    +CampaignsTriggerScheduleUpdateObject | braze-api
    +
  • Defined in campaigns/trigger/schedule/types.ts:40
    • diff --git a/interfaces/CampaignsTriggerSendObject.html b/interfaces/CampaignsTriggerSendObject.html index 9bd19c395..09b834edd 100644 --- a/interfaces/CampaignsTriggerSendObject.html +++ b/interfaces/CampaignsTriggerSendObject.html @@ -1,4 +1,4 @@ -CampaignsTriggerSendObject | braze-api
    +CampaignsTriggerSendObject | braze-api
    +
  • Defined in campaigns/trigger/types.ts:16
    • diff --git a/interfaces/CanvasTriggerScheduleCreatResponse.html b/interfaces/CanvasTriggerScheduleCreatResponse.html index be0c2e2b6..4c2a6c03b 100644 --- a/interfaces/CanvasTriggerScheduleCreatResponse.html +++ b/interfaces/CanvasTriggerScheduleCreatResponse.html @@ -1,4 +1,4 @@ -CanvasTriggerScheduleCreatResponse | braze-api
    +CanvasTriggerScheduleCreatResponse | braze-api
    +
  • Defined in canvas/trigger/schedule/types.ts:21
    • diff --git a/interfaces/CanvasTriggerScheduleCreateObject.html b/interfaces/CanvasTriggerScheduleCreateObject.html index 315711e11..a66eb0689 100644 --- a/interfaces/CanvasTriggerScheduleCreateObject.html +++ b/interfaces/CanvasTriggerScheduleCreateObject.html @@ -1,4 +1,4 @@ -CanvasTriggerScheduleCreateObject | braze-api
    +CanvasTriggerScheduleCreateObject | braze-api
    +
  • Defined in canvas/trigger/types.ts:17

    • Optional broadcast

    broadcast?: boolean
    +
  • Defined in canvas/trigger/types.ts:16

    • Optional canvas_entry_properties

    canvas_entry_properties?: object
    +
  • Defined in canvas/trigger/types.ts:15

    • canvas_id

    canvas_id: string
    +
  • Defined in canvas/trigger/types.ts:14

    • Optional recipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]
    +
  • Defined in canvas/trigger/types.ts:18

    • schedule

    schedule: ScheduleObject
    +
  • Defined in canvas/trigger/schedule/types.ts:11
    • diff --git a/interfaces/CanvasTriggerScheduleDeleteObject.html b/interfaces/CanvasTriggerScheduleDeleteObject.html index 5ea5f54d5..c66f8691e 100644 --- a/interfaces/CanvasTriggerScheduleDeleteObject.html +++ b/interfaces/CanvasTriggerScheduleDeleteObject.html @@ -1,4 +1,4 @@ -CanvasTriggerScheduleDeleteObject | braze-api
    +CanvasTriggerScheduleDeleteObject | braze-api
    +
  • Defined in canvas/trigger/schedule/types.ts:31
    • diff --git a/interfaces/CanvasTriggerScheduleUpdateObject.html b/interfaces/CanvasTriggerScheduleUpdateObject.html index 77c5427ed..b8033baef 100644 --- a/interfaces/CanvasTriggerScheduleUpdateObject.html +++ b/interfaces/CanvasTriggerScheduleUpdateObject.html @@ -1,4 +1,4 @@ -CanvasTriggerScheduleUpdateObject | braze-api
    +CanvasTriggerScheduleUpdateObject | braze-api
    +
  • Defined in canvas/trigger/schedule/types.ts:41
    • diff --git a/interfaces/CanvasTriggerSendObject.html b/interfaces/CanvasTriggerSendObject.html index fb8497920..9dbe628bd 100644 --- a/interfaces/CanvasTriggerSendObject.html +++ b/interfaces/CanvasTriggerSendObject.html @@ -1,4 +1,4 @@ -CanvasTriggerSendObject | braze-api
    +CanvasTriggerSendObject | braze-api
    +
  • Defined in canvas/trigger/types.ts:18
    • diff --git a/interfaces/CatalogListItemBody.html b/interfaces/CatalogListItemBody.html index 2c5623a85..00ce896bb 100644 --- a/interfaces/CatalogListItemBody.html +++ b/interfaces/CatalogListItemBody.html @@ -1,4 +1,4 @@ -CatalogListItemBody | braze-api
    +CatalogListItemBody | braze-api
    +
  • Defined in catalogs/synchronous/types.ts:49
    • diff --git a/interfaces/CatalogListItemResponse.html b/interfaces/CatalogListItemResponse.html index 541dbca30..6e6d32e31 100644 --- a/interfaces/CatalogListItemResponse.html +++ b/interfaces/CatalogListItemResponse.html @@ -1,4 +1,4 @@ -CatalogListItemResponse | braze-api
    +CatalogListItemResponse | braze-api
    +
  • Defined in common/request/request.ts:13

    • items

    items: [T]
    +
  • Defined in catalogs/synchronous/types.ts:60

    • message

    message: string
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/CatalogListItemsBody.html b/interfaces/CatalogListItemsBody.html index 343b88c44..35f017285 100644 --- a/interfaces/CatalogListItemsBody.html +++ b/interfaces/CatalogListItemsBody.html @@ -1,4 +1,4 @@ -CatalogListItemsBody | braze-api
    +CatalogListItemsBody | braze-api
    +
  • Defined in catalogs/synchronous/types.ts:25
    • diff --git a/interfaces/CatalogListItemsResponse.html b/interfaces/CatalogListItemsResponse.html index 2ee324848..e309b12db 100644 --- a/interfaces/CatalogListItemsResponse.html +++ b/interfaces/CatalogListItemsResponse.html @@ -1,4 +1,4 @@ -CatalogListItemsResponse | braze-api
    +CatalogListItemsResponse | braze-api
    +
  • Defined in common/request/request.ts:13

    • items

    items: T[]
    +
  • Defined in catalogs/synchronous/types.ts:39

    • message

    message: string
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/CatalogListResponse.html b/interfaces/CatalogListResponse.html index e9b999c8b..f577aeece 100644 --- a/interfaces/CatalogListResponse.html +++ b/interfaces/CatalogListResponse.html @@ -1,4 +1,4 @@ -CatalogListResponse | braze-api
    +CatalogListResponse | braze-api
    +
  • Defined in catalogs/synchronous/types.ts:9

    • Optional errors

    errors?: string[]
    +
  • Defined in common/request/request.ts:13

    • message

    message: string
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/ConnectedAudienceObject.html b/interfaces/ConnectedAudienceObject.html index 71019ee85..f911fc202 100644 --- a/interfaces/ConnectedAudienceObject.html +++ b/interfaces/ConnectedAudienceObject.html @@ -1,4 +1,4 @@ -ConnectedAudienceObject | braze-api
    +ConnectedAudienceObject | braze-api
    +
  • Defined in common/types.ts:8
    • diff --git a/interfaces/ContentBlockBody.html b/interfaces/ContentBlockBody.html index 3a875709e..d32e85009 100644 --- a/interfaces/ContentBlockBody.html +++ b/interfaces/ContentBlockBody.html @@ -1,4 +1,4 @@ -ContentBlockBody | braze-api
    +ContentBlockBody | braze-api
    +
  • Defined in templates/content_blocks/types.ts:41
    • diff --git a/interfaces/ContentBlockListBody.html b/interfaces/ContentBlockListBody.html index 408247a4c..716c66d90 100644 --- a/interfaces/ContentBlockListBody.html +++ b/interfaces/ContentBlockListBody.html @@ -1,4 +1,4 @@ -ContentBlockListBody | braze-api
    +ContentBlockListBody | braze-api
    +
  • Defined in templates/content_blocks/types.ts:12
    • diff --git a/interfaces/ContentBlockListResponse.html b/interfaces/ContentBlockListResponse.html index 9a1de6a23..fc92ca268 100644 --- a/interfaces/ContentBlockListResponse.html +++ b/interfaces/ContentBlockListResponse.html @@ -1,4 +1,4 @@ -ContentBlockListResponse | braze-api
    +ContentBlockListResponse | braze-api
    +
  • Defined in templates/content_blocks/types.ts:22

    • count

    count: number
    +
  • Defined in templates/content_blocks/types.ts:21

    • Optional errors

    errors?: string[]
    +
  • Defined in common/request/request.ts:13

    • message

    message: string
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/ContentBlockResponse.html b/interfaces/ContentBlockResponse.html index a3c04b1d1..25f5091de 100644 --- a/interfaces/ContentBlockResponse.html +++ b/interfaces/ContentBlockResponse.html @@ -1,4 +1,4 @@ -ContentBlockResponse | braze-api
    +ContentBlockResponse | braze-api
    +
  • Defined in templates/content_blocks/types.ts:55
    • diff --git a/interfaces/CreateEmailTemplateBody.html b/interfaces/CreateEmailTemplateBody.html index aa809ea7b..92c3da045 100644 --- a/interfaces/CreateEmailTemplateBody.html +++ b/interfaces/CreateEmailTemplateBody.html @@ -1,4 +1,4 @@ -CreateEmailTemplateBody | braze-api
    +CreateEmailTemplateBody | braze-api
    +
  • Defined in templates/email_templates/types.ts:65
    • diff --git a/interfaces/EmailBlacklistObject.html b/interfaces/EmailBlacklistObject.html index 0f262d445..d317d8621 100644 --- a/interfaces/EmailBlacklistObject.html +++ b/interfaces/EmailBlacklistObject.html @@ -1,4 +1,4 @@ -EmailBlacklistObject | braze-api
    +EmailBlacklistObject | braze-api
    +
  • Defined in email/types.ts:10
    • diff --git a/interfaces/EmailBounceRemoveObject.html b/interfaces/EmailBounceRemoveObject.html index defb0a4f5..f386e5076 100644 --- a/interfaces/EmailBounceRemoveObject.html +++ b/interfaces/EmailBounceRemoveObject.html @@ -1,4 +1,4 @@ -EmailBounceRemoveObject | braze-api
    +EmailBounceRemoveObject | braze-api
    +
  • Defined in email/bounce/types.ts:7
    • diff --git a/interfaces/EmailSpamRemoveObject.html b/interfaces/EmailSpamRemoveObject.html index 903105185..3c3bb68dd 100644 --- a/interfaces/EmailSpamRemoveObject.html +++ b/interfaces/EmailSpamRemoveObject.html @@ -1,4 +1,4 @@ -EmailSpamRemoveObject | braze-api
    +EmailSpamRemoveObject | braze-api
    +
  • Defined in email/spam/types.ts:7
    • diff --git a/interfaces/EmailTemplateBody.html b/interfaces/EmailTemplateBody.html index e7e76ea8e..ca0c62a0f 100644 --- a/interfaces/EmailTemplateBody.html +++ b/interfaces/EmailTemplateBody.html @@ -1,4 +1,4 @@ -EmailTemplateBody | braze-api
    +EmailTemplateBody | braze-api
    +
  • Defined in templates/email_templates/types.ts:37
    • diff --git a/interfaces/EmailTemplateListBody.html b/interfaces/EmailTemplateListBody.html index ee19e2762..524d433af 100644 --- a/interfaces/EmailTemplateListBody.html +++ b/interfaces/EmailTemplateListBody.html @@ -1,4 +1,4 @@ -EmailTemplateListBody | braze-api
    +EmailTemplateListBody | braze-api
    +
  • Defined in templates/email_templates/types.ts:12
    • diff --git a/interfaces/EmailTemplateListResponse.html b/interfaces/EmailTemplateListResponse.html index 6487d7447..cda9676ba 100644 --- a/interfaces/EmailTemplateListResponse.html +++ b/interfaces/EmailTemplateListResponse.html @@ -1,4 +1,4 @@ -EmailTemplateListResponse | braze-api
    +EmailTemplateListResponse | braze-api
    +
  • Defined in templates/email_templates/types.ts:22
    • diff --git a/interfaces/EmailTemplateResponse.html b/interfaces/EmailTemplateResponse.html index 029dce561..0fddeb3aa 100644 --- a/interfaces/EmailTemplateResponse.html +++ b/interfaces/EmailTemplateResponse.html @@ -1,4 +1,4 @@ -EmailTemplateResponse | braze-api
    +EmailTemplateResponse | braze-api
    +
  • Defined in templates/email_templates/types.ts:56
    • diff --git a/interfaces/MessagesObject.html b/interfaces/MessagesObject.html index 84ad1b0c7..47e22704d 100644 --- a/interfaces/MessagesObject.html +++ b/interfaces/MessagesObject.html @@ -1,4 +1,4 @@ -MessagesObject | braze-api
    +MessagesObject | braze-api
    +
  • Defined in messages/types.ts:33
    • diff --git a/interfaces/MessagesScheduleCreateObject.html b/interfaces/MessagesScheduleCreateObject.html index 288cc8b36..e4f2a6dda 100644 --- a/interfaces/MessagesScheduleCreateObject.html +++ b/interfaces/MessagesScheduleCreateObject.html @@ -1,4 +1,4 @@ -MessagesScheduleCreateObject | braze-api
    +MessagesScheduleCreateObject | braze-api
    +
  • Defined in messages/types.ts:16

    • Optional broadcast

    broadcast?: boolean
    +
  • Defined in messages/types.ts:12

    • Optional campaign_id

    campaign_id?: string
    +
  • Defined in messages/types.ts:17

    • Optional external_user_ids

    external_user_ids?: string[]
    +
  • Defined in messages/types.ts:13

    • Optional messages

    messages?: MessagesObject
    +
  • Defined in messages/types.ts:21

    • Optional override_messaging_limits

    override_messaging_limits?: boolean
    +
  • Defined in messages/schedule/types.ts:11

    • Optional recipient_subscription_state

    recipient_subscription_state?: string
    +
  • Defined in messages/types.ts:20

    • schedule

    schedule: ScheduleObject
    +
  • Defined in messages/schedule/types.ts:12

    • Optional segment_id

    segment_id?: string
    +
  • Defined in messages/types.ts:15

    • Optional send_id

    send_id?: string
    +
  • Defined in messages/types.ts:18

    • Optional user_aliases

    user_aliases?: UserAlias[]
    +
  • Defined in messages/types.ts:14
    • diff --git a/interfaces/MessagesScheduleDeleteObject.html b/interfaces/MessagesScheduleDeleteObject.html index 7f89b7a8a..876e20433 100644 --- a/interfaces/MessagesScheduleDeleteObject.html +++ b/interfaces/MessagesScheduleDeleteObject.html @@ -1,4 +1,4 @@ -MessagesScheduleDeleteObject | braze-api
    +MessagesScheduleDeleteObject | braze-api
    +
  • Defined in messages/schedule/types.ts:21
    • diff --git a/interfaces/MessagesScheduleUpdateObject.html b/interfaces/MessagesScheduleUpdateObject.html index 7c49c032c..a1b3acc01 100644 --- a/interfaces/MessagesScheduleUpdateObject.html +++ b/interfaces/MessagesScheduleUpdateObject.html @@ -1,4 +1,4 @@ -MessagesScheduleUpdateObject | braze-api
    +MessagesScheduleUpdateObject | braze-api
    +
  • Defined in messages/schedule/types.ts:30
    • diff --git a/interfaces/MessagesSendObject.html b/interfaces/MessagesSendObject.html index 3c5808a13..fa9ec0fdd 100644 --- a/interfaces/MessagesSendObject.html +++ b/interfaces/MessagesSendObject.html @@ -1,4 +1,4 @@ -MessagesSendObject | braze-api
    +MessagesSendObject | braze-api
    +
  • Defined in messages/types.ts:14
    • diff --git a/interfaces/PostEmailTemplateResponse.html b/interfaces/PostEmailTemplateResponse.html index ced929056..591c074e2 100644 --- a/interfaces/PostEmailTemplateResponse.html +++ b/interfaces/PostEmailTemplateResponse.html @@ -1,4 +1,4 @@ -PostEmailTemplateResponse | braze-api
    +PostEmailTemplateResponse | braze-api
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/ScheduleObject.html b/interfaces/ScheduleObject.html index 984fd8bf1..7e954493d 100644 --- a/interfaces/ScheduleObject.html +++ b/interfaces/ScheduleObject.html @@ -1,4 +1,4 @@ -ScheduleObject | braze-api
    +ScheduleObject | braze-api
    +
  • Defined in common/types.ts:69
    • diff --git a/interfaces/ScheduledBroadcastsObject.html b/interfaces/ScheduledBroadcastsObject.html index eb6c9b692..653365d24 100644 --- a/interfaces/ScheduledBroadcastsObject.html +++ b/interfaces/ScheduledBroadcastsObject.html @@ -1,4 +1,4 @@ -ScheduledBroadcastsObject | braze-api
    +ScheduledBroadcastsObject | braze-api
    +
  • Defined in messages/types.ts:72
    • diff --git a/interfaces/ScheduledBroadcastsResponse.html b/interfaces/ScheduledBroadcastsResponse.html index 03815b223..27a2dcee9 100644 --- a/interfaces/ScheduledBroadcastsResponse.html +++ b/interfaces/ScheduledBroadcastsResponse.html @@ -1,4 +1,4 @@ -ScheduledBroadcastsResponse | braze-api
    +ScheduledBroadcastsResponse | braze-api
    +
  • Defined in common/request/request.ts:13

    • message

    message: string
    +
  • Defined in common/request/request.ts:12

    • scheduled_broadcasts

    scheduled_broadcasts: {
        id: string;
        name: string;
        next_send_time: string;
        schedule_type: string;
        tags: string[];
        type: "Canvas" | "Campaign";
    }[]
    @@ -67,7 +67,7 @@
    tags
    type: "Canvas" | "Campaign"
    +
  • Defined in messages/types.ts:76
    • diff --git a/interfaces/SendsIdCreateObject.html b/interfaces/SendsIdCreateObject.html index caf395ebe..5a2f92ba2 100644 --- a/interfaces/SendsIdCreateObject.html +++ b/interfaces/SendsIdCreateObject.html @@ -1,4 +1,4 @@ -SendsIdCreateObject | braze-api
    +SendsIdCreateObject | braze-api
    +
  • Defined in sends/id/types.ts:8
    • diff --git a/interfaces/SubscriptionStatusGetObject.html b/interfaces/SubscriptionStatusGetObject.html index 47a3c3b18..a033d989a 100644 --- a/interfaces/SubscriptionStatusGetObject.html +++ b/interfaces/SubscriptionStatusGetObject.html @@ -1,4 +1,4 @@ -SubscriptionStatusGetObject | braze-api
    +SubscriptionStatusGetObject | braze-api
    +
  • Defined in subscription/status/types.ts:16
    • diff --git a/interfaces/SubscriptionUserStatusObject.html b/interfaces/SubscriptionUserStatusObject.html index 3630238dd..94aec0ec8 100644 --- a/interfaces/SubscriptionUserStatusObject.html +++ b/interfaces/SubscriptionUserStatusObject.html @@ -1,4 +1,4 @@ -SubscriptionUserStatusObject | braze-api
    +SubscriptionUserStatusObject | braze-api
    +
  • Defined in subscription/user/types.ts:9
    • diff --git a/interfaces/SubscriptionUserStatusResponse.html b/interfaces/SubscriptionUserStatusResponse.html index 07588b147..fb5391dd0 100644 --- a/interfaces/SubscriptionUserStatusResponse.html +++ b/interfaces/SubscriptionUserStatusResponse.html @@ -1,4 +1,4 @@ -SubscriptionUserStatusResponse | braze-api
    +SubscriptionUserStatusResponse | braze-api
    +
  • Defined in subscription/user/types.ts:15
    • diff --git a/interfaces/TransactionalV1CampaignsSendObject.html b/interfaces/TransactionalV1CampaignsSendObject.html index e4905a35a..57c9d481a 100644 --- a/interfaces/TransactionalV1CampaignsSendObject.html +++ b/interfaces/TransactionalV1CampaignsSendObject.html @@ -1,4 +1,4 @@ -TransactionalV1CampaignsSendObject | braze-api
    +TransactionalV1CampaignsSendObject | braze-api
    +
  • Defined in transactional/v1/campaigns/types.ts:11
    • diff --git a/interfaces/UpdateEmailTemplateBody.html b/interfaces/UpdateEmailTemplateBody.html index 81b482c23..458e98674 100644 --- a/interfaces/UpdateEmailTemplateBody.html +++ b/interfaces/UpdateEmailTemplateBody.html @@ -1,4 +1,4 @@ -UpdateEmailTemplateBody | braze-api
    +UpdateEmailTemplateBody | braze-api
    +
  • Defined in templates/email_templates/types.ts:67

    • email_template_id

    email_template_id: string
    +
  • Defined in templates/email_templates/types.ts:80

    • Optional plaintext_body

    plaintext_body?: string
    +
  • Defined in templates/email_templates/types.ts:68

    • Optional preheader

    preheader?: string
    +
  • Defined in templates/email_templates/types.ts:69

    • Optional should_inline_css

    should_inline_css?: boolean
    +
  • Defined in templates/email_templates/types.ts:71

    • subject

    subject: string
    +
  • Defined in templates/email_templates/types.ts:66

    • Optional tags

    tags?: string[]
    +
  • Defined in templates/email_templates/types.ts:70

    • template_name

    template_name: string
    +
  • Defined in templates/email_templates/types.ts:65
    • diff --git a/interfaces/UserAlias.html b/interfaces/UserAlias.html index c416dc782..466371fd6 100644 --- a/interfaces/UserAlias.html +++ b/interfaces/UserAlias.html @@ -1,4 +1,4 @@ -UserAlias | braze-api
    +UserAlias | braze-api
    +
  • Defined in common/types.ts:59
    • diff --git a/interfaces/UsersAliasObject.html b/interfaces/UsersAliasObject.html index de17b832a..10ba5c5df 100644 --- a/interfaces/UsersAliasObject.html +++ b/interfaces/UsersAliasObject.html @@ -1,4 +1,4 @@ -UsersAliasObject | braze-api
    +UsersAliasObject | braze-api
    +
  • Defined in users/alias/types.ts:7
    • diff --git a/interfaces/UsersDeleteObject.html b/interfaces/UsersDeleteObject.html index cb4405f97..e48b584a9 100644 --- a/interfaces/UsersDeleteObject.html +++ b/interfaces/UsersDeleteObject.html @@ -1,4 +1,4 @@ -UsersDeleteObject | braze-api
    +UsersDeleteObject | braze-api
    +
  • Defined in users/types.ts:50
    • diff --git a/interfaces/UsersDeleteResponse.html b/interfaces/UsersDeleteResponse.html index 23fd503c2..4f967cb49 100644 --- a/interfaces/UsersDeleteResponse.html +++ b/interfaces/UsersDeleteResponse.html @@ -1,4 +1,4 @@ -UsersDeleteResponse | braze-api
    +UsersDeleteResponse | braze-api
    +
  • Defined in common/request/request.ts:12
    • diff --git a/interfaces/UsersExportGlobalControlGroupObject.html b/interfaces/UsersExportGlobalControlGroupObject.html index 35debe74e..d37aeccb8 100644 --- a/interfaces/UsersExportGlobalControlGroupObject.html +++ b/interfaces/UsersExportGlobalControlGroupObject.html @@ -1,4 +1,4 @@ -UsersExportGlobalControlGroupObject | braze-api
    +UsersExportGlobalControlGroupObject | braze-api
    +
  • Defined in users/export/types.ts:11
    • diff --git a/interfaces/UsersExportGlobalControlGroupResponse.html b/interfaces/UsersExportGlobalControlGroupResponse.html index 52ec11bcd..ede6a5f0d 100644 --- a/interfaces/UsersExportGlobalControlGroupResponse.html +++ b/interfaces/UsersExportGlobalControlGroupResponse.html @@ -1,4 +1,4 @@ -UsersExportGlobalControlGroupResponse | braze-api
    +UsersExportGlobalControlGroupResponse | braze-api
    +
  • Defined in users/export/types.ts:22
    • diff --git a/interfaces/UsersExportIdsObject.html b/interfaces/UsersExportIdsObject.html index c2ac2229a..79a1d0a64 100644 --- a/interfaces/UsersExportIdsObject.html +++ b/interfaces/UsersExportIdsObject.html @@ -1,4 +1,4 @@ -UsersExportIdsObject | braze-api
    +UsersExportIdsObject | braze-api
    +
  • Defined in users/export/types.ts:32
    • diff --git a/interfaces/UsersExportIdsResponse.html b/interfaces/UsersExportIdsResponse.html index 35d9820f5..e2b51c57f 100644 --- a/interfaces/UsersExportIdsResponse.html +++ b/interfaces/UsersExportIdsResponse.html @@ -1,4 +1,4 @@ -UsersExportIdsResponse | braze-api
    +UsersExportIdsResponse | braze-api
    +
  • Defined in users/export/types.ts:47
    • diff --git a/interfaces/UsersExportSegmentObject.html b/interfaces/UsersExportSegmentObject.html index 63d44c997..a6b79002c 100644 --- a/interfaces/UsersExportSegmentObject.html +++ b/interfaces/UsersExportSegmentObject.html @@ -1,4 +1,4 @@ -UsersExportSegmentObject | braze-api
    +UsersExportSegmentObject | braze-api
    +
  • Defined in users/export/types.ts:57
    • diff --git a/interfaces/UsersExportSegmentResponse.html b/interfaces/UsersExportSegmentResponse.html index 7f053175a..d84af3d7f 100644 --- a/interfaces/UsersExportSegmentResponse.html +++ b/interfaces/UsersExportSegmentResponse.html @@ -1,4 +1,4 @@ -UsersExportSegmentResponse | braze-api
    +UsersExportSegmentResponse | braze-api
    +
  • Defined in users/export/types.ts:71
    • diff --git a/interfaces/UsersExternalIdsRemoveObject.html b/interfaces/UsersExternalIdsRemoveObject.html index c38e9f0a7..15688cf30 100644 --- a/interfaces/UsersExternalIdsRemoveObject.html +++ b/interfaces/UsersExternalIdsRemoveObject.html @@ -1,4 +1,4 @@ -UsersExternalIdsRemoveObject | braze-api
    +UsersExternalIdsRemoveObject | braze-api
    +
  • Defined in users/external_ids/types.ts:7
    • diff --git a/interfaces/UsersExternalIdsRenameObject.html b/interfaces/UsersExternalIdsRenameObject.html index 53b12857f..6562b19cb 100644 --- a/interfaces/UsersExternalIdsRenameObject.html +++ b/interfaces/UsersExternalIdsRenameObject.html @@ -1,4 +1,4 @@ -UsersExternalIdsRenameObject | braze-api
    +UsersExternalIdsRenameObject | braze-api
    +
  • Defined in users/external_ids/types.ts:16
    • diff --git a/interfaces/UsersIdentifyObject.html b/interfaces/UsersIdentifyObject.html index f2a83b10f..342ddda3b 100644 --- a/interfaces/UsersIdentifyObject.html +++ b/interfaces/UsersIdentifyObject.html @@ -1,4 +1,4 @@ -UsersIdentifyObject | braze-api
    +UsersIdentifyObject | braze-api
    +
  • Defined in users/types.ts:25
    • diff --git a/interfaces/UsersMergeObject.html b/interfaces/UsersMergeObject.html index 066694384..00a733da7 100644 --- a/interfaces/UsersMergeObject.html +++ b/interfaces/UsersMergeObject.html @@ -1,4 +1,4 @@ -UsersMergeObject | braze-api
    +UsersMergeObject | braze-api
    +
  • Defined in users/types.ts:37
    • diff --git a/interfaces/UsersTrackObject.html b/interfaces/UsersTrackObject.html index b875b0c2c..6af8bba09 100644 --- a/interfaces/UsersTrackObject.html +++ b/interfaces/UsersTrackObject.html @@ -1,4 +1,4 @@ -UsersTrackObject | braze-api
    +UsersTrackObject | braze-api
    +
  • Defined in users/types.ts:16
    • diff --git a/interfaces/V2SubscriptionStatusSetObject.html b/interfaces/V2SubscriptionStatusSetObject.html index 401f7da65..830bc14e6 100644 --- a/interfaces/V2SubscriptionStatusSetObject.html +++ b/interfaces/V2SubscriptionStatusSetObject.html @@ -1,4 +1,4 @@ -V2SubscriptionStatusSetObject | braze-api
    +V2SubscriptionStatusSetObject | braze-api
    +
  • Defined in v2/subscription/status/types.ts:7
    • diff --git a/modules.html b/modules.html index b1a29c263..7d3b392b9 100644 --- a/modules.html +++ b/modules.html @@ -1,4 +1,4 @@ -braze-api
    +braze-api
    diff --git a/types/CatalogListItem.html b/types/CatalogListItem.html index 3c86523c1..963665477 100644 --- a/types/CatalogListItem.html +++ b/types/CatalogListItem.html @@ -1,4 +1,4 @@ -CatalogListItem | braze-api
    +CatalogListItem | braze-api
    +
  • Defined in catalogs/synchronous/types.ts:28
    • diff --git a/types/Properties.html b/types/Properties.html index d745fe656..3a8b9eac1 100644 --- a/types/Properties.html +++ b/types/Properties.html @@ -1,4 +1,4 @@ -Properties | braze-api
    +Properties | braze-api
    Properties: object
    +
  • Defined in common/types.ts:54
    • diff --git a/types/SubscriptionStatusSetObject.html b/types/SubscriptionStatusSetObject.html index b2f37b31a..5f04b4e02 100644 --- a/types/SubscriptionStatusSetObject.html +++ b/types/SubscriptionStatusSetObject.html @@ -1,4 +1,4 @@ -SubscriptionStatusSetObject | braze-api
    +SubscriptionStatusSetObject | braze-api
    +
  • Defined in subscription/status/types.ts:6
    • diff --git a/types/TriggerProperties.html b/types/TriggerProperties.html index 8d1158bc6..759f88ca3 100644 --- a/types/TriggerProperties.html +++ b/types/TriggerProperties.html @@ -1,4 +1,4 @@ -TriggerProperties | braze-api
    +TriggerProperties | braze-api
    TriggerProperties: object
    +
  • Defined in common/types.ts:52