From dc6afc3756fd5ea65437a8b0fe758ab75d704a41 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" Date: Tue, 17 Sep 2024 04:45:14 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20braze-co?= =?UTF-8?q?mmunity/braze-node@e8e0d25c8921579543e0be815086a270f9abe4e7=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- classes/Braze.html | 28 +++++++++---------- hierarchy.html | 2 +- index.html | 2 +- .../AndroidConversationPushMessageObject.html | 6 ++-- interfaces/AndroidConversationPushObject.html | 6 ++-- .../AndroidConversationPushPersonObject.html | 6 ++-- interfaces/AndroidPushActionButtonObject.html | 6 ++-- interfaces/AndroidPushObject.html | 6 ++-- interfaces/ApplePushActionButtonObject.html | 6 ++-- interfaces/ApplePushAlertObject.html | 6 ++-- interfaces/ApplePushObject.html | 6 ++-- interfaces/CampaignSendResponse.html | 6 ++-- interfaces/CampaignsListParameters.html | 6 ++-- interfaces/CampaignsListResponse.html | 6 ++-- .../CampaignsTriggerScheduleCreateObject.html | 6 ++-- ...ampaignsTriggerScheduleCreateResponse.html | 6 ++-- .../CampaignsTriggerScheduleDeleteObject.html | 6 ++-- .../CampaignsTriggerScheduleUpdateObject.html | 6 ++-- interfaces/CampaignsTriggerSendObject.html | 6 ++-- interfaces/CanvasListParameters.html | 6 ++-- interfaces/CanvasListResponse.html | 6 ++-- .../CanvasTriggerScheduleCreatResponse.html | 6 ++-- .../CanvasTriggerScheduleCreateObject.html | 6 ++-- .../CanvasTriggerScheduleDeleteObject.html | 6 ++-- .../CanvasTriggerScheduleUpdateObject.html | 6 ++-- interfaces/CanvasTriggerSendObject.html | 6 ++-- interfaces/CatalogListItemBody.html | 6 ++-- interfaces/CatalogListItemResponse.html | 6 ++-- interfaces/CatalogListItemsBody.html | 6 ++-- interfaces/CatalogListItemsResponse.html | 6 ++-- interfaces/CatalogListResponse.html | 6 ++-- interfaces/ConnectedAudienceObject.html | 6 ++-- interfaces/ContentBlockBody.html | 6 ++-- interfaces/ContentBlockListBody.html | 6 ++-- interfaces/ContentBlockListResponse.html | 6 ++-- interfaces/ContentBlockResponse.html | 6 ++-- interfaces/CreateContentBlockBody.html | 6 ++-- interfaces/CreateEmailTemplateBody.html | 6 ++-- interfaces/EmailBlacklistObject.html | 6 ++-- interfaces/EmailBounceRemoveObject.html | 6 ++-- interfaces/EmailSpamRemoveObject.html | 6 ++-- interfaces/EmailTemplateBody.html | 6 ++-- interfaces/EmailTemplateListBody.html | 6 ++-- interfaces/EmailTemplateListResponse.html | 6 ++-- interfaces/EmailTemplateResponse.html | 6 ++-- interfaces/MessagesObject.html | 6 ++-- interfaces/MessagesScheduleCreateObject.html | 6 ++-- interfaces/MessagesScheduleDeleteObject.html | 6 ++-- interfaces/MessagesScheduleUpdateObject.html | 6 ++-- interfaces/MessagesSendObject.html | 6 ++-- interfaces/PostContentBlockResponse.html | 6 ++-- interfaces/PostEmailTemplateResponse.html | 6 ++-- interfaces/ScheduleObject.html | 6 ++-- interfaces/ScheduledBroadcastsObject.html | 4 +-- interfaces/ScheduledBroadcastsResponse.html | 4 +-- interfaces/SendsIdCreateObject.html | 6 ++-- interfaces/SubscriptionStatusGetObject.html | 6 ++-- interfaces/SubscriptionUserStatusObject.html | 6 ++-- .../SubscriptionUserStatusResponse.html | 4 +-- .../TransactionalV1CampaignsSendObject.html | 6 ++-- interfaces/UpdateContentBlockBody.html | 6 ++-- interfaces/UpdateEmailTemplateBody.html | 6 ++-- interfaces/UserAlias.html | 4 +-- interfaces/UserAliasUpdateObject.html | 4 +-- interfaces/UserAliasUpdates.html | 6 ++-- interfaces/UsersAliasObject.html | 6 ++-- interfaces/UsersDeleteObject.html | 6 ++-- interfaces/UsersDeleteResponse.html | 6 ++-- .../UsersExportGlobalControlGroupObject.html | 6 ++-- ...UsersExportGlobalControlGroupResponse.html | 6 ++-- interfaces/UsersExportIdsObject.html | 6 ++-- interfaces/UsersExportIdsResponse.html | 6 ++-- interfaces/UsersExportSegmentObject.html | 6 ++-- interfaces/UsersExportSegmentResponse.html | 6 ++-- interfaces/UsersExternalIdsRemoveObject.html | 6 ++-- interfaces/UsersExternalIdsRenameObject.html | 6 ++-- interfaces/UsersIdentifyObject.html | 6 ++-- interfaces/UsersMergeObject.html | 6 ++-- interfaces/UsersTrackObject.html | 6 ++-- interfaces/V2SubscriptionStatusSetObject.html | 6 ++-- modules.html | 2 +- types/Attributes.html | 2 +- types/CatalogListItem.html | 2 +- types/Properties.html | 2 +- types/SubscriptionStatusSetObject.html | 4 +-- types/TriggerProperties.html | 2 +- 87 files changed, 250 insertions(+), 250 deletions(-) diff --git a/404.html b/404.html index 508f973d..7ef30821 100644 --- a/404.html +++ b/404.html @@ -1,3 +1,3 @@ -braze-api

braze-api

+braze-api

braze-api

Not Found

Settings

Member Visibility

On This Page

braze-api
diff --git a/classes/Braze.html b/classes/Braze.html index 4363e3db..5c2fb627 100644 --- a/classes/Braze.html +++ b/classes/Braze.html @@ -1,4 +1,4 @@ -Braze | braze-api

Class Braze

Constructors

constructor +Braze | braze-api

Class Braze

Constructors

constructor

Properties

campaigns canvas catalogs @@ -13,39 +13,39 @@ v2

Constructors

constructor

  • new Braze(apiUrl, apiKey): Braze

  • Parameters

    • apiUrl: string

      Braze REST endpoint.

    • apiKey: string

      Braze API key.

      -

    Returns Braze

Properties

campaigns

campaigns: {
    list: ((parameters?: CampaignsListParameters) => Promise<CampaignsListResponse>);
    trigger: {
        schedule: {
            create: ((body: CampaignsTriggerScheduleCreateObject) => Promise<CampaignsTriggerScheduleCreateResponse>);
            delete: ((body: CampaignsTriggerScheduleDeleteObject) => Promise<ServerResponse>);
            update: ((body: CampaignsTriggerScheduleUpdateObject) => Promise<ServerResponse>);
        };
        send: ((body: CampaignsTriggerSendObject) => Promise<{
            dispatch_id: string;
            message: string;
        }>);
    };
} = ...

Type declaration

Returns Braze

Properties

campaigns

campaigns: {
    list: ((parameters?: CampaignsListParameters) => Promise<CampaignsListResponse>);
    trigger: {
        schedule: {
            create: ((body: CampaignsTriggerScheduleCreateObject) => Promise<CampaignsTriggerScheduleCreateResponse>);
            delete: ((body: CampaignsTriggerScheduleDeleteObject) => Promise<ServerResponse>);
            update: ((body: CampaignsTriggerScheduleUpdateObject) => Promise<ServerResponse>);
        };
        send: ((body: CampaignsTriggerSendObject) => Promise<{
            dispatch_id: string;
            message: string;
        }>);
    };
} = ...

Type declaration

canvas

canvas: {
    list: ((parameters?: CanvasListParameters) => Promise<CanvasListResponse>);
    trigger: {
        schedule: {
            create: ((body: CanvasTriggerScheduleCreateObject) => Promise<CanvasTriggerScheduleCreatResponse>);
            delete: ((body: CanvasTriggerScheduleDeleteObject) => Promise<ServerResponse>);
            update: ((body: CanvasTriggerScheduleUpdateObject) => Promise<ServerResponse>);
        };
        send: ((body: CanvasTriggerSendObject) => Promise<{
            dispatch_id: string;
            message: string;
        }>);
    };
} = ...

Type declaration

canvas

canvas: {
    list: ((parameters?: CanvasListParameters) => Promise<CanvasListResponse>);
    trigger: {
        schedule: {
            create: ((body: CanvasTriggerScheduleCreateObject) => Promise<CanvasTriggerScheduleCreatResponse>);
            delete: ((body: CanvasTriggerScheduleDeleteObject) => Promise<ServerResponse>);
            update: ((body: CanvasTriggerScheduleUpdateObject) => Promise<ServerResponse>);
        };
        send: ((body: CanvasTriggerSendObject) => Promise<{
            dispatch_id: string;
            message: string;
        }>);
    };
} = ...

Type declaration

catalogs

catalogs: {
    synchronous: {
        item: (<T>(body: CatalogListItemBody) => Promise<CatalogListItemResponse<T>>);
        items: (<T>(body: CatalogListItemsBody) => AsyncGenerator<T, any, any>);
        list: (() => Promise<CatalogListResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/catalogs

+
    • (body): Promise<{
          dispatch_id: string;
          message: string;
      }>

    • Parameters

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

catalogs

catalogs: {
    synchronous: {
        item: (<T>(body: CatalogListItemBody) => Promise<CatalogListItemResponse<T>>);
        items: (<T>(body: CatalogListItemsBody) => AsyncGenerator<T, any, any>);
        list: (() => Promise<CatalogListResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/catalogs

Type declaration

email

email: {
    blacklist: ((body: EmailBlacklistObject) => Promise<ServerResponse>);
    bounce: {
        remove: ((body: EmailBounceRemoveObject) => Promise<ServerResponse>);
    };
    spam: {
        remove: ((body: EmailSpamRemoveObject) => Promise<ServerResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/email

+

email

email: {
    blacklist: ((body: EmailBlacklistObject) => Promise<ServerResponse>);
    bounce: {
        remove: ((body: EmailBounceRemoveObject) => Promise<ServerResponse>);
    };
    spam: {
        remove: ((body: EmailSpamRemoveObject) => Promise<ServerResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/email

Type declaration

messages

messages: {
    schedule: {
        create: ((body: MessagesScheduleCreateObject) => Promise<{
            dispatch_id: string;
            message: string;
            schedule_id: string;
        }>);
        delete: ((body: MessagesScheduleDeleteObject) => Promise<ServerResponse>);
        update: ((body: MessagesScheduleUpdateObject) => Promise<ServerResponse>);
    };
    scheduled_broadcasts: ((body: ScheduledBroadcastsObject) => Promise<ScheduledBroadcastsResponse>);
    send: ((body: MessagesSendObject) => Promise<{
        dispatch_id: string;
        message: string;
    }>);
} = ...

https://www.braze.com/docs/api/endpoints/messaging

+

messages

messages: {
    schedule: {
        create: ((body: MessagesScheduleCreateObject) => Promise<{
            dispatch_id: string;
            message: string;
            schedule_id: string;
        }>);
        delete: ((body: MessagesScheduleDeleteObject) => Promise<ServerResponse>);
        update: ((body: MessagesScheduleUpdateObject) => Promise<ServerResponse>);
    };
    scheduled_broadcasts: ((body: ScheduledBroadcastsObject) => Promise<ScheduledBroadcastsResponse>);
    send: ((body: MessagesSendObject) => Promise<{
        dispatch_id: string;
        message: string;
    }>);
} = ...

https://www.braze.com/docs/api/endpoints/messaging

Type declaration

segments

segments: {
    analytics: ((parameters: SegmentsAnalyticsParameters) => Promise<SegmentsAnalyticsResponse>);
    details: ((parameters: SegmentsDetailsParameters) => Promise<SegmentsDetailsResponse>);
    list: ((parameters?: SegmentsListParameters) => Promise<SegmentsListResponse>);
} = ...

Type declaration

  • analytics: ((parameters: SegmentsAnalyticsParameters) => Promise<SegmentsAnalyticsResponse>)

    GET /segments/data_series

    +
      • (body): Promise<{
            dispatch_id: string;
            message: string;
        }>

      • Parameters

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

segments

segments: {
    analytics: ((parameters: SegmentsAnalyticsParameters) => Promise<SegmentsAnalyticsResponse>);
    details: ((parameters: SegmentsDetailsParameters) => Promise<SegmentsDetailsResponse>);
    list: ((parameters?: SegmentsListParameters) => Promise<SegmentsListResponse>);
} = ...

Type declaration

  • analytics: ((parameters: SegmentsAnalyticsParameters) => Promise<SegmentsAnalyticsResponse>)

    GET /segments/data_series

      • (parameters): Promise<SegmentsAnalyticsResponse>

      • Parameters

        • parameters: SegmentsAnalyticsParameters

        Returns Promise<SegmentsAnalyticsResponse>

  • details: ((parameters: SegmentsDetailsParameters) => Promise<SegmentsDetailsResponse>)

    GET /segments/details

      • (parameters): Promise<SegmentsDetailsResponse>

      • Parameters

        • parameters: SegmentsDetailsParameters

        Returns Promise<SegmentsDetailsResponse>

  • list: ((parameters?: SegmentsListParameters) => Promise<SegmentsListResponse>)

    GET /segments/list

    -
      • (parameters?): Promise<SegmentsListResponse>

      • Parameters

        • Optionalparameters: SegmentsListParameters

        Returns Promise<SegmentsListResponse>

sends

sends: {
    id: {
        create: ((body: SendsIdCreateObject) => Promise<{
            message: string;
            send_id: string;
        }>);
    };
} = ...

Type declaration

  • id: {
        create: ((body: SendsIdCreateObject) => Promise<{
            message: string;
            send_id: string;
        }>);
    }
    • create: ((body: SendsIdCreateObject) => Promise<{
          message: string;
          send_id: string;
      }>)

      POST /sends/id/create

      -
        • (body): Promise<{
              message: string;
              send_id: string;
          }>

        • Parameters

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

subscription

subscription: {
    status: {
        get: ((body: SubscriptionStatusGetObject) => Promise<{
            message: string;
            status: Record<string, "Subscribed" | "Unsubscribed" | "Unknown">;
        }>);
        set: ((body: SubscriptionStatusSetObject) => Promise<{
            message: string;
        }>);
    };
    user: {
        status: ((body: SubscriptionUserStatusObject) => Promise<SubscriptionUserStatusResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/subscription_groups

+
    • (parameters?): Promise<SegmentsListResponse>

    • Parameters

      • Optionalparameters: SegmentsListParameters

      Returns Promise<SegmentsListResponse>

sends

sends: {
    id: {
        create: ((body: SendsIdCreateObject) => Promise<{
            message: string;
            send_id: string;
        }>);
    };
} = ...

Type declaration

  • id: {
        create: ((body: SendsIdCreateObject) => Promise<{
            message: string;
            send_id: string;
        }>);
    }
    • create: ((body: SendsIdCreateObject) => Promise<{
          message: string;
          send_id: string;
      }>)

      POST /sends/id/create

      +
        • (body): Promise<{
              message: string;
              send_id: string;
          }>

        • Parameters

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

subscription

subscription: {
    status: {
        get: ((body: SubscriptionStatusGetObject) => Promise<{
            message: string;
            status: Record<string, "Subscribed" | "Unsubscribed" | "Unknown">;
        }>);
        set: ((body: SubscriptionStatusSetObject) => Promise<{
            message: string;
        }>);
    };
    user: {
        status: ((body: SubscriptionUserStatusObject) => Promise<SubscriptionUserStatusResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/subscription_groups

Type declaration

templates

templates: {
    content_blocks: {
        create: ((body: CreateContentBlockBody) => Promise<PostContentBlockResponse>);
        get: ((body: ContentBlockBody) => Promise<ContentBlockResponse>);
        list: ((body: ContentBlockListBody) => Promise<ContentBlockListResponse>);
        update: ((body: UpdateContentBlockBody) => Promise<PostContentBlockResponse>);
    };
    email_templates: {
        create: ((body: CreateEmailTemplateBody) => Promise<PostEmailTemplateResponse>);
        get: ((body: EmailTemplateBody) => Promise<EmailTemplateResponse>);
        list: ((body: EmailTemplateListBody) => Promise<EmailTemplateListResponse>);
        update: ((body: UpdateEmailTemplateBody) => Promise<PostEmailTemplateResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/templates

+

templates

templates: {
    content_blocks: {
        create: ((body: CreateContentBlockBody) => Promise<PostContentBlockResponse>);
        get: ((body: ContentBlockBody) => Promise<ContentBlockResponse>);
        list: ((body: ContentBlockListBody) => Promise<ContentBlockListResponse>);
        update: ((body: UpdateContentBlockBody) => Promise<PostContentBlockResponse>);
    };
    email_templates: {
        create: ((body: CreateEmailTemplateBody) => Promise<PostEmailTemplateResponse>);
        get: ((body: EmailTemplateBody) => Promise<EmailTemplateResponse>);
        list: ((body: EmailTemplateListBody) => Promise<EmailTemplateListResponse>);
        update: ((body: UpdateEmailTemplateBody) => Promise<PostEmailTemplateResponse>);
    };
} = ...

https://www.braze.com/docs/api/endpoints/templates

Type declaration

transactional

transactional: {
    v1: {
        campaigns: {
            send: ((campaignId: string, body: TransactionalV1CampaignsSendObject) => Promise<CampaignSendResponse>);
        };
    };
} = ...

Type declaration

users

users: {
    alias: {
        new: ((body: UsersAliasObject) => Promise<ServerResponse>);
        update: ((body: UserAliasUpdates) => Promise<ServerResponse>);
    };
    delete: ((body: UsersDeleteObject) => Promise<UsersDeleteResponse>);
    export: {
        global_control_group: ((body: UsersExportGlobalControlGroupObject) => Promise<UsersExportGlobalControlGroupResponse>);
        ids: ((body: UsersExportIdsObject) => Promise<UsersExportIdsResponse>);
        segment: ((body: UsersExportSegmentObject) => Promise<UsersExportSegmentResponse>);
    };
    external_ids: {
        remove: ((body: UsersExternalIdsRemoveObject) => Promise<{
            message: string;
            removal_errors: string[];
            removed_ids: string[];
        }>);
        rename: ((body: UsersExternalIdsRenameObject) => Promise<{
            external_ids: string[];
            message: string;
            rename_errors: string[];
        }>);
    };
    identify: ((body: UsersIdentifyObject) => Promise<ServerResponse>);
    merge: ((body: UsersMergeObject) => Promise<ServerResponse>);
    track: ((body: UsersTrackObject, bulk?: boolean) => Promise<{
        attributes_processed?: number;
        errors?: object[];
        events_processed?: number;
        message: string;
        purchases_processed?: number;
    }>);
} = ...

https://www.braze.com/docs/api/endpoints/user_data

+

transactional

transactional: {
    v1: {
        campaigns: {
            send: ((campaignId: string, body: TransactionalV1CampaignsSendObject) => Promise<CampaignSendResponse>);
        };
    };
} = ...

Type declaration

users

users: {
    alias: {
        new: ((body: UsersAliasObject) => Promise<ServerResponse>);
        update: ((body: UserAliasUpdates) => Promise<ServerResponse>);
    };
    delete: ((body: UsersDeleteObject) => Promise<UsersDeleteResponse>);
    export: {
        global_control_group: ((body: UsersExportGlobalControlGroupObject) => Promise<UsersExportGlobalControlGroupResponse>);
        ids: ((body: UsersExportIdsObject) => Promise<UsersExportIdsResponse>);
        segment: ((body: UsersExportSegmentObject) => Promise<UsersExportSegmentResponse>);
    };
    external_ids: {
        remove: ((body: UsersExternalIdsRemoveObject) => Promise<{
            message: string;
            removal_errors: string[];
            removed_ids: string[];
        }>);
        rename: ((body: UsersExternalIdsRenameObject) => Promise<{
            external_ids: string[];
            message: string;
            rename_errors: string[];
        }>);
    };
    identify: ((body: UsersIdentifyObject) => Promise<ServerResponse>);
    merge: ((body: UsersMergeObject) => Promise<ServerResponse>);
    track: ((body: UsersTrackObject, bulk?: boolean) => Promise<{
        attributes_processed?: number;
        errors?: object[];
        events_processed?: number;
        message: string;
        purchases_processed?: number;
    }>);
} = ...

https://www.braze.com/docs/api/endpoints/user_data

Type declaration

  • alias: {
        new: ((body: UsersAliasObject) => Promise<ServerResponse>);
        update: ((body: UserAliasUpdates) => Promise<ServerResponse>);
    }
    • new: ((body: UsersAliasObject) => Promise<ServerResponse>)

      POST /users/alias/new

        • (body): Promise<ServerResponse>

        • Parameters

          Returns Promise<ServerResponse>

    • update: ((body: UserAliasUpdates) => Promise<ServerResponse>)

      POST /users/alias/update

        • (body): Promise<ServerResponse>

        • Parameters

          Returns Promise<ServerResponse>

  • delete: ((body: UsersDeleteObject) => Promise<UsersDeleteResponse>)

    POST /users/delete

    @@ -68,6 +68,6 @@
      • (body): Promise<{
            external_ids: string[];
            message: string;
            rename_errors: string[];
        }>

      • Parameters

        Returns Promise<{
            external_ids: string[];
            message: string;
            rename_errors: string[];
        }>

  • identify: ((body: UsersIdentifyObject) => Promise<ServerResponse>)

    POST /users/identify

      • (body): Promise<ServerResponse>

      • Parameters

        Returns Promise<ServerResponse>

  • merge: ((body: UsersMergeObject) => Promise<ServerResponse>)

    POST /users/merge

      • (body): Promise<ServerResponse>

      • Parameters

        Returns Promise<ServerResponse>

  • track: ((body: UsersTrackObject, bulk?: boolean) => Promise<{
        attributes_processed?: number;
        errors?: object[];
        events_processed?: number;
        message: string;
        purchases_processed?: number;
    }>)

    POST /users/track

    -
      • (body, bulk?): Promise<{
            attributes_processed?: number;
            errors?: object[];
            events_processed?: number;
            message: string;
            purchases_processed?: number;
        }>

      • Parameters

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

    • v2

    v2: {
        subscription: {
            status: {
                set: ((body: V2SubscriptionStatusSetObject) => Promise<{
                    message: string;
                }>);
            };
        };
    } = ...

    Type declaration

    • subscription: {
          status: {
              set: ((body: V2SubscriptionStatusSetObject) => Promise<{
                  message: string;
              }>);
          };
      }

      https://www.braze.com/docs/api/endpoints/subscription_groups

      +
        • (body, bulk?): Promise<{
              attributes_processed?: number;
              errors?: object[];
              events_processed?: number;
              message: string;
              purchases_processed?: number;
          }>

        • Parameters

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

    v2

    v2: {
        subscription: {
            status: {
                set: ((body: V2SubscriptionStatusSetObject) => Promise<{
                    message: string;
                }>);
            };
        };
    } = ...

    Type declaration

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/hierarchy.html b/hierarchy.html index 411ebdf9..358ae5ff 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -braze-api

    braze-api

    Class Hierarchy

    Settings

    Member Visibility
    +braze-api

    braze-api

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/index.html b/index.html index 846c60be..9038d136 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -braze-api

    braze-api

    +braze-api

    braze-api

    braze-api

    NPM

    NPM version diff --git a/interfaces/AndroidConversationPushMessageObject.html b/interfaces/AndroidConversationPushMessageObject.html index a50667de..7f1011d7 100644 --- a/interfaces/AndroidConversationPushMessageObject.html +++ b/interfaces/AndroidConversationPushMessageObject.html @@ -1,6 +1,6 @@ -AndroidConversationPushMessageObject | braze-api

    Interface AndroidConversationPushMessageObject

    Android conversation push message object

    +AndroidConversationPushMessageObject | braze-api

    Interface AndroidConversationPushMessageObject

    Android conversation push message object

    https://www.braze.com/docs/api/objects_filters/messaging/android_object/#android-conversation-push-message-object

    -
    interface AndroidConversationPushMessageObject {
        person_id: string;
        text: string;
        timestamp: number;
    }

    Properties

    person_id +
    interface AndroidConversationPushMessageObject {
        person_id: string;
        text: string;
        timestamp: number;
    }

    Properties

    person_id text timestamp -

    Properties

    person_id

    person_id: string

    text

    text: string

    timestamp

    timestamp: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    person_id

    person_id: string

    text

    text: string

    timestamp

    timestamp: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/AndroidConversationPushObject.html b/interfaces/AndroidConversationPushObject.html index bfc43f74..e6bbd400 100644 --- a/interfaces/AndroidConversationPushObject.html +++ b/interfaces/AndroidConversationPushObject.html @@ -1,7 +1,7 @@ -AndroidConversationPushObject | braze-api

    Interface AndroidConversationPushObject

    Android conversation push object

    +AndroidConversationPushObject | braze-api

    Interface AndroidConversationPushObject

    Android conversation push object

    https://www.braze.com/docs/api/objects_filters/messaging/android_object/#android-conversation-push-object

    -
    interface AndroidConversationPushObject {
        messages: AndroidConversationPushMessageObject[];
        persons: AndroidConversationPushPersonObject[];
        reply_person_id: string;
        shortcut_id: string;
    }

    Properties

    messages +
    interface AndroidConversationPushObject {
        messages: AndroidConversationPushMessageObject[];
        persons: AndroidConversationPushPersonObject[];
        reply_person_id: string;
        shortcut_id: string;
    }

    Properties

    messages persons reply_person_id shortcut_id -

    Properties

    messages

    messages: AndroidConversationPushMessageObject[]

    persons

    persons: AndroidConversationPushPersonObject[]

    reply_person_id

    reply_person_id: string

    shortcut_id

    shortcut_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    messages

    messages: AndroidConversationPushMessageObject[]

    persons

    persons: AndroidConversationPushPersonObject[]

    reply_person_id

    reply_person_id: string

    shortcut_id

    shortcut_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/AndroidConversationPushPersonObject.html b/interfaces/AndroidConversationPushPersonObject.html index f76fbd69..30516f30 100644 --- a/interfaces/AndroidConversationPushPersonObject.html +++ b/interfaces/AndroidConversationPushPersonObject.html @@ -1,5 +1,5 @@ -AndroidConversationPushPersonObject | braze-api

    Interface AndroidConversationPushPersonObject

    Android conversation push person object

    +AndroidConversationPushPersonObject | braze-api

    Interface AndroidConversationPushPersonObject

    Android conversation push person object

    https://www.braze.com/docs/api/objects_filters/messaging/android_object/#android-conversation-push-person-object

    -
    interface AndroidConversationPushPersonObject {
        id: string;
        name: string;
    }

    Properties

    id +
    interface AndroidConversationPushPersonObject {
        id: string;
        name: string;
    }

    Properties

    id name -

    Properties

    id

    id: string

    name

    name: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    id

    id: string

    name

    name: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/AndroidPushActionButtonObject.html b/interfaces/AndroidPushActionButtonObject.html index b3f1b624..ee62cba5 100644 --- a/interfaces/AndroidPushActionButtonObject.html +++ b/interfaces/AndroidPushActionButtonObject.html @@ -1,7 +1,7 @@ -AndroidPushActionButtonObject | braze-api

    Interface AndroidPushActionButtonObject

    Android push action button object

    +AndroidPushActionButtonObject | braze-api

    Interface AndroidPushActionButtonObject

    Android push action button object

    https://www.braze.com/docs/api/objects_filters/messaging/android_object/#android-push-action-button-object

    -
    interface AndroidPushActionButtonObject {
        action?:
            | "OPEN_APP"
            | "URI"
            | "DEEP_LINK"
            | "CLOSE";
        text: string;
        uri?: string;
        use_webview?: boolean;
    }

    Properties

    action? +
    interface AndroidPushActionButtonObject {
        action?:
            | "OPEN_APP"
            | "URI"
            | "DEEP_LINK"
            | "CLOSE";
        text: string;
        uri?: string;
        use_webview?: boolean;
    }

    Properties

    action? text uri? use_webview? -

    Properties

    Optionalaction

    action?:
        | "OPEN_APP"
        | "URI"
        | "DEEP_LINK"
        | "CLOSE"

    text

    text: string

    Optionaluri

    uri?: string

    Optionaluse_webview

    use_webview?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaction

    action?:
        | "OPEN_APP"
        | "URI"
        | "DEEP_LINK"
        | "CLOSE"

    text

    text: string

    Optionaluri

    uri?: string

    Optionaluse_webview

    use_webview?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/AndroidPushObject.html b/interfaces/AndroidPushObject.html index c0340b15..b33a0c35 100644 --- a/interfaces/AndroidPushObject.html +++ b/interfaces/AndroidPushObject.html @@ -1,6 +1,6 @@ -AndroidPushObject | braze-api

    Interface AndroidPushObject

    Android push object

    +AndroidPushObject | braze-api

    Interface AndroidPushObject

    Android push object

    https://www.braze.com/docs/api/objects_filters/messaging/android_object

    -
    interface AndroidPushObject {
        accent_color?: number;
        alert: string;
        buttons?: AndroidPushActionButtonObject[];
        collapse_key?: string;
        conversation_data?: AndroidConversationPushObject;
        custom_uri?: string;
        extra?: Record<string, string>;
        message_variation_id?: string;
        notification_channel_id?: string;
        notification_id?: number;
        priority?: number;
        push_icon_image_url?: string;
        send_to_most_recent_device_only?: boolean;
        send_to_sync?: boolean;
        sound?: string;
        summary_text?: string;
        time_to_live?: number;
        title: string;
    }

    Properties

    accent_color? +
    interface AndroidPushObject {
        accent_color?: number;
        alert: string;
        buttons?: AndroidPushActionButtonObject[];
        collapse_key?: string;
        conversation_data?: AndroidConversationPushObject;
        custom_uri?: string;
        extra?: Record<string, string>;
        message_variation_id?: string;
        notification_channel_id?: string;
        notification_id?: number;
        priority?: number;
        push_icon_image_url?: string;
        send_to_most_recent_device_only?: boolean;
        send_to_sync?: boolean;
        sound?: string;
        summary_text?: string;
        time_to_live?: number;
        title: string;
    }

    Properties

    accent_color? alert buttons? collapse_key? @@ -18,4 +18,4 @@ summary_text? time_to_live? title -

    Properties

    Optionalaccent_color

    accent_color?: number

    alert

    alert: string

    Optionalbuttons

    buttons?: AndroidPushActionButtonObject[]

    Optionalcollapse_key

    collapse_key?: string

    Optionalconversation_data

    conversation_data?: AndroidConversationPushObject

    Optionalcustom_uri

    custom_uri?: string

    Optionalextra

    extra?: Record<string, string>

    Optionalmessage_variation_id

    message_variation_id?: string

    Optionalnotification_channel_id

    notification_channel_id?: string

    Optionalnotification_id

    notification_id?: number

    Optionalpriority

    priority?: number

    Optionalpush_icon_image_url

    push_icon_image_url?: string

    Optionalsend_to_most_recent_device_only

    send_to_most_recent_device_only?: boolean

    Optionalsend_to_sync

    send_to_sync?: boolean

    Optionalsound

    sound?: string

    Optionalsummary_text

    summary_text?: string

    Optionaltime_to_live

    time_to_live?: number

    title

    title: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaccent_color

    accent_color?: number

    alert

    alert: string

    Optionalbuttons

    buttons?: AndroidPushActionButtonObject[]

    Optionalcollapse_key

    collapse_key?: string

    Optionalconversation_data

    conversation_data?: AndroidConversationPushObject

    Optionalcustom_uri

    custom_uri?: string

    Optionalextra

    extra?: Record<string, string>

    Optionalmessage_variation_id

    message_variation_id?: string

    Optionalnotification_channel_id

    notification_channel_id?: string

    Optionalnotification_id

    notification_id?: number

    Optionalpriority

    priority?: number

    Optionalpush_icon_image_url

    push_icon_image_url?: string

    Optionalsend_to_most_recent_device_only

    send_to_most_recent_device_only?: boolean

    Optionalsend_to_sync

    send_to_sync?: boolean

    Optionalsound

    sound?: string

    Optionalsummary_text

    summary_text?: string

    Optionaltime_to_live

    time_to_live?: number

    title

    title: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ApplePushActionButtonObject.html b/interfaces/ApplePushActionButtonObject.html index a2669b70..2506426f 100644 --- a/interfaces/ApplePushActionButtonObject.html +++ b/interfaces/ApplePushActionButtonObject.html @@ -1,7 +1,7 @@ -ApplePushActionButtonObject | braze-api

    Interface ApplePushActionButtonObject

    Apple push action button object

    +ApplePushActionButtonObject | braze-api

    Interface ApplePushActionButtonObject

    Apple push action button object

    https://www.braze.com/docs/api/objects_filters/messaging/apple_object/#apple-push-action-button-object

    -
    interface ApplePushActionButtonObject {
        action?:
            | "OPEN_APP"
            | "URI"
            | "DEEP_LINK"
            | "CLOSE";
        action_id: string;
        uri?: string;
        use_webview?: boolean;
    }

    Properties

    action? +
    interface ApplePushActionButtonObject {
        action?:
            | "OPEN_APP"
            | "URI"
            | "DEEP_LINK"
            | "CLOSE";
        action_id: string;
        uri?: string;
        use_webview?: boolean;
    }

    Properties

    action? action_id uri? use_webview? -

    Properties

    Optionalaction

    action?:
        | "OPEN_APP"
        | "URI"
        | "DEEP_LINK"
        | "CLOSE"

    action_id

    action_id: string

    Optionaluri

    uri?: string

    Optionaluse_webview

    use_webview?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaction

    action?:
        | "OPEN_APP"
        | "URI"
        | "DEEP_LINK"
        | "CLOSE"

    action_id

    action_id: string

    Optionaluri

    uri?: string

    Optionaluse_webview

    use_webview?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ApplePushAlertObject.html b/interfaces/ApplePushAlertObject.html index 1a63f388..b397ecbe 100644 --- a/interfaces/ApplePushAlertObject.html +++ b/interfaces/ApplePushAlertObject.html @@ -1,6 +1,6 @@ -ApplePushAlertObject | braze-api

    Interface ApplePushAlertObject

    Apple push alert object

    +ApplePushAlertObject | braze-api

    Interface ApplePushAlertObject

    Apple push alert object

    https://www.braze.com/docs/api/objects_filters/messaging/apple_object/#apple-push-alert-object

    -
    interface ApplePushAlertObject {
        action_loc_key?: string;
        body: string;
        loc_args?: string[];
        loc_key?: string;
        sound?: string;
        title?: string;
        title_loc_args?: string[];
        title_loc_key?: string;
    }

    Properties

    action_loc_key? +
    interface ApplePushAlertObject {
        action_loc_key?: string;
        body: string;
        loc_args?: string[];
        loc_key?: string;
        sound?: string;
        title?: string;
        title_loc_args?: string[];
        title_loc_key?: string;
    }

    Properties

    action_loc_key? body loc_args? loc_key? @@ -8,4 +8,4 @@ title? title_loc_args? title_loc_key? -

    Properties

    Optionalaction_loc_key

    action_loc_key?: string

    body

    body: string

    Optionalloc_args

    loc_args?: string[]

    Optionalloc_key

    loc_key?: string

    Optionalsound

    sound?: string

    Optionaltitle

    title?: string

    Optionaltitle_loc_args

    title_loc_args?: string[]

    Optionaltitle_loc_key

    title_loc_key?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaction_loc_key

    action_loc_key?: string

    body

    body: string

    Optionalloc_args

    loc_args?: string[]

    Optionalloc_key

    loc_key?: string

    Optionalsound

    sound?: string

    Optionaltitle

    title?: string

    Optionaltitle_loc_args

    title_loc_args?: string[]

    Optionaltitle_loc_key

    title_loc_key?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ApplePushObject.html b/interfaces/ApplePushObject.html index 8e684135..7ce40309 100644 --- a/interfaces/ApplePushObject.html +++ b/interfaces/ApplePushObject.html @@ -1,6 +1,6 @@ -ApplePushObject | braze-api

    Interface ApplePushObject

    Apple push object

    +ApplePushObject | braze-api

    Interface ApplePushObject

    Apple push object

    https://www.braze.com/docs/api/objects_filters/messaging/apple_object

    -
    interface ApplePushObject {
        alert?: string | ApplePushAlertObject;
        asset_file_type?:
            | "aif"
            | "gif"
            | "jpg"
            | "m4a"
            | "mp3"
            | "mp4"
            | "png"
            | "wav";
        asset_url?: string;
        badge?: number;
        buttons?: ApplePushActionButtonObject[];
        category?: string;
        collapse_id?: string;
        content-available?: boolean;
        custom_uri?: string;
        expiry?: string;
        extra?: Record<string, string>;
        interruption_level?:
            | "passive"
            | "active"
            | "time-sensitive"
            | "critical";
        message_variation_id?: string;
        mutable_content?: boolean;
        notification_group_thread_id?: string;
        relevance_score?: number;
        send_to_most_recent_device_only?: boolean;
        sound?: string;
    }

    Properties

    alert? +
    interface ApplePushObject {
        alert?: string | ApplePushAlertObject;
        asset_file_type?:
            | "aif"
            | "gif"
            | "jpg"
            | "m4a"
            | "mp3"
            | "mp4"
            | "png"
            | "wav";
        asset_url?: string;
        badge?: number;
        buttons?: ApplePushActionButtonObject[];
        category?: string;
        collapse_id?: string;
        content-available?: boolean;
        custom_uri?: string;
        expiry?: string;
        extra?: Record<string, string>;
        interruption_level?:
            | "passive"
            | "active"
            | "time-sensitive"
            | "critical";
        message_variation_id?: string;
        mutable_content?: boolean;
        notification_group_thread_id?: string;
        relevance_score?: number;
        send_to_most_recent_device_only?: boolean;
        sound?: string;
    }

    Properties

    alert? asset_file_type? asset_url? badge? @@ -18,4 +18,4 @@ relevance_score? send_to_most_recent_device_only? sound? -

    Properties

    Optionalalert

    alert?: string | ApplePushAlertObject

    Optionalasset_file_type

    asset_file_type?:
        | "aif"
        | "gif"
        | "jpg"
        | "m4a"
        | "mp3"
        | "mp4"
        | "png"
        | "wav"

    Optionalasset_url

    asset_url?: string

    Optionalbadge

    badge?: number

    Optionalbuttons

    buttons?: ApplePushActionButtonObject[]

    Optionalcategory

    category?: string

    Optionalcollapse_id

    collapse_id?: string

    Optionalcontent-available

    content-available?: boolean

    Optionalcustom_uri

    custom_uri?: string

    Optionalexpiry

    expiry?: string

    Optionalextra

    extra?: Record<string, string>

    Optionalinterruption_level

    interruption_level?:
        | "passive"
        | "active"
        | "time-sensitive"
        | "critical"

    Optionalmessage_variation_id

    message_variation_id?: string

    Optionalmutable_content

    mutable_content?: boolean

    Optionalnotification_group_thread_id

    notification_group_thread_id?: string

    Optionalrelevance_score

    relevance_score?: number

    Optionalsend_to_most_recent_device_only

    send_to_most_recent_device_only?: boolean

    Optionalsound

    sound?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalalert

    alert?: string | ApplePushAlertObject

    Optionalasset_file_type

    asset_file_type?:
        | "aif"
        | "gif"
        | "jpg"
        | "m4a"
        | "mp3"
        | "mp4"
        | "png"
        | "wav"

    Optionalasset_url

    asset_url?: string

    Optionalbadge

    badge?: number

    Optionalbuttons

    buttons?: ApplePushActionButtonObject[]

    Optionalcategory

    category?: string

    Optionalcollapse_id

    collapse_id?: string

    Optionalcontent-available

    content-available?: boolean

    Optionalcustom_uri

    custom_uri?: string

    Optionalexpiry

    expiry?: string

    Optionalextra

    extra?: Record<string, string>

    Optionalinterruption_level

    interruption_level?:
        | "passive"
        | "active"
        | "time-sensitive"
        | "critical"

    Optionalmessage_variation_id

    message_variation_id?: string

    Optionalmutable_content

    mutable_content?: boolean

    Optionalnotification_group_thread_id

    notification_group_thread_id?: string

    Optionalrelevance_score

    relevance_score?: number

    Optionalsend_to_most_recent_device_only

    send_to_most_recent_device_only?: boolean

    Optionalsound

    sound?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignSendResponse.html b/interfaces/CampaignSendResponse.html index d01a028c..5238e6fa 100644 --- a/interfaces/CampaignSendResponse.html +++ b/interfaces/CampaignSendResponse.html @@ -1,8 +1,8 @@ -CampaignSendResponse | braze-api

    Interface CampaignSendResponse

    Postback body for sending transactional email via API-triggered delivery.

    +CampaignSendResponse | braze-api

    Interface CampaignSendResponse

    Postback body for sending transactional email via API-triggered delivery.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_transactional_message/#postback-body

    -
    interface CampaignSendResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        metadata: {
            aborted_at?: string;
            bounced_at?: string;
            campaign_api_id: string;
            delivered_at?: string;
            enqueued_at?: string;
            executed_at?: string;
            external_send_id: string;
            processed_at?: string;
            reason?: string;
            received_at?: string;
            sent_at?: string;
        };
        status:
            | "aborted"
            | "sent"
            | "processed"
            | "delivered"
            | "bounced";
    }

    Hierarchy

    • ServerResponse
      • CampaignSendResponse

    Properties

    dispatch_id +
    interface CampaignSendResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        metadata: {
            aborted_at?: string;
            bounced_at?: string;
            campaign_api_id: string;
            delivered_at?: string;
            enqueued_at?: string;
            executed_at?: string;
            external_send_id: string;
            processed_at?: string;
            reason?: string;
            received_at?: string;
            sent_at?: string;
        };
        status:
            | "aborted"
            | "sent"
            | "processed"
            | "delivered"
            | "bounced";
    }

    Hierarchy

    • ServerResponse
      • CampaignSendResponse

    Properties

    dispatch_id errors? message metadata status -

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    metadata

    metadata: {
        aborted_at?: string;
        bounced_at?: string;
        campaign_api_id: string;
        delivered_at?: string;
        enqueued_at?: string;
        executed_at?: string;
        external_send_id: string;
        processed_at?: string;
        reason?: string;
        received_at?: string;
        sent_at?: string;
    }

    status

    status:
        | "aborted"
        | "sent"
        | "processed"
        | "delivered"
        | "bounced"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    metadata

    metadata: {
        aborted_at?: string;
        bounced_at?: string;
        campaign_api_id: string;
        delivered_at?: string;
        enqueued_at?: string;
        executed_at?: string;
        external_send_id: string;
        processed_at?: string;
        reason?: string;
        received_at?: string;
        sent_at?: string;
    }

    status

    status:
        | "aborted"
        | "sent"
        | "processed"
        | "delivered"
        | "bounced"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsListParameters.html b/interfaces/CampaignsListParameters.html index d52f9560..b30a02b8 100644 --- a/interfaces/CampaignsListParameters.html +++ b/interfaces/CampaignsListParameters.html @@ -1,7 +1,7 @@ -CampaignsListParameters | braze-api

    Interface CampaignsListParameters

    Request parameters for campaigns list.

    +CampaignsListParameters | braze-api

    Interface CampaignsListParameters

    Request parameters for campaigns list.

    https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns/#request-parameters

    -
    interface CampaignsListParameters {
        include_archived?: boolean;
        last_edit.time[gt]?: string;
        page?: number;
        sort_direction?: string;
    }

    Properties

    include_archived? +
    interface CampaignsListParameters {
        include_archived?: boolean;
        last_edit.time[gt]?: string;
        page?: number;
        sort_direction?: string;
    }

    Properties

    include_archived? last_edit.time[gt]? page? sort_direction? -

    Properties

    Optionalinclude_archived

    include_archived?: boolean

    Optionallast_edit.time[gt]

    last_edit.time[gt]?: string

    Optionalpage

    page?: number

    Optionalsort_direction

    sort_direction?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalinclude_archived

    include_archived?: boolean

    Optionallast_edit.time[gt]

    last_edit.time[gt]?: string

    Optionalpage

    page?: number

    Optionalsort_direction

    sort_direction?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsListResponse.html b/interfaces/CampaignsListResponse.html index 97a60f89..304f1313 100644 --- a/interfaces/CampaignsListResponse.html +++ b/interfaces/CampaignsListResponse.html @@ -1,6 +1,6 @@ -CampaignsListResponse | braze-api

    Interface CampaignsListResponse

    Response body for campaigns list.

    +CampaignsListResponse | braze-api

    Interface CampaignsListResponse

    Response body for campaigns list.

    https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns/#response

    -
    interface CampaignsListResponse {
        campaigns: {
            id: string;
            is_api_campaign: boolean;
            last_edited: string;
            name: string;
            tags: string[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CampaignsListResponse

    Properties

    campaigns +
    interface CampaignsListResponse {
        campaigns: {
            id: string;
            is_api_campaign: boolean;
            last_edited: string;
            name: string;
            tags: string[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CampaignsListResponse

    Properties

    campaigns errors? message -

    Properties

    campaigns

    campaigns: {
        id: string;
        is_api_campaign: boolean;
        last_edited: string;
        name: string;
        tags: string[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    campaigns

    campaigns: {
        id: string;
        is_api_campaign: boolean;
        last_edited: string;
        name: string;
        tags: string[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsTriggerScheduleCreateObject.html b/interfaces/CampaignsTriggerScheduleCreateObject.html index adaa0368..5c7f4664 100644 --- a/interfaces/CampaignsTriggerScheduleCreateObject.html +++ b/interfaces/CampaignsTriggerScheduleCreateObject.html @@ -1,10 +1,10 @@ -CampaignsTriggerScheduleCreateObject | braze-api

    Interface CampaignsTriggerScheduleCreateObject

    Request body for schedule API-triggered campaigns.

    +CampaignsTriggerScheduleCreateObject | braze-api

    Interface CampaignsTriggerScheduleCreateObject

    Request body for schedule API-triggered campaigns.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns/#request-body

    -
    interface CampaignsTriggerScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        schedule: ScheduleObject;
        send_id?: string;
        trigger_properties?: object;
    }

    Hierarchy (view full)

    Properties

    audience? +
    interface CampaignsTriggerScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        schedule: ScheduleObject;
        send_id?: string;
        trigger_properties?: object;
    }

    Hierarchy (view full)

    Properties

    audience? broadcast? campaign_id recipients? schedule send_id? trigger_properties? -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    campaign_id

    campaign_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    schedule

    schedule: ScheduleObject

    Optionalsend_id

    send_id?: string

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    campaign_id

    campaign_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    schedule

    schedule: ScheduleObject

    Optionalsend_id

    send_id?: string

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsTriggerScheduleCreateResponse.html b/interfaces/CampaignsTriggerScheduleCreateResponse.html index cd8efc83..af4cf281 100644 --- a/interfaces/CampaignsTriggerScheduleCreateResponse.html +++ b/interfaces/CampaignsTriggerScheduleCreateResponse.html @@ -1,7 +1,7 @@ -CampaignsTriggerScheduleCreateResponse | braze-api

    Interface CampaignsTriggerScheduleCreateResponse

    Response body for schedule API-triggered campaigns.

    +CampaignsTriggerScheduleCreateResponse | braze-api

    Interface CampaignsTriggerScheduleCreateResponse

    Response body for schedule API-triggered campaigns.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns/#request-body

    -
    interface CampaignsTriggerScheduleCreateResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        schedule_id: string;
    }

    Hierarchy

    • ServerResponse
      • CampaignsTriggerScheduleCreateResponse

    Properties

    dispatch_id +
    interface CampaignsTriggerScheduleCreateResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        schedule_id: string;
    }

    Hierarchy

    • ServerResponse
      • CampaignsTriggerScheduleCreateResponse

    Properties

    dispatch_id errors? message schedule_id -

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsTriggerScheduleDeleteObject.html b/interfaces/CampaignsTriggerScheduleDeleteObject.html index b8bfa1d5..a092701a 100644 --- a/interfaces/CampaignsTriggerScheduleDeleteObject.html +++ b/interfaces/CampaignsTriggerScheduleDeleteObject.html @@ -1,5 +1,5 @@ -CampaignsTriggerScheduleDeleteObject | braze-api

    Interface CampaignsTriggerScheduleDeleteObject

    Request body for delete scheduled API-triggered campaigns.

    +CampaignsTriggerScheduleDeleteObject | braze-api

    Interface CampaignsTriggerScheduleDeleteObject

    Request body for delete scheduled API-triggered campaigns.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_messages/#request-body

    -
    interface CampaignsTriggerScheduleDeleteObject {
        campaign_id: string;
        schedule_id: string;
    }

    Properties

    campaign_id +
    interface CampaignsTriggerScheduleDeleteObject {
        campaign_id: string;
        schedule_id: string;
    }

    Properties

    campaign_id schedule_id -

    Properties

    campaign_id

    campaign_id: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    campaign_id

    campaign_id: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsTriggerScheduleUpdateObject.html b/interfaces/CampaignsTriggerScheduleUpdateObject.html index d91c7ae4..583665f5 100644 --- a/interfaces/CampaignsTriggerScheduleUpdateObject.html +++ b/interfaces/CampaignsTriggerScheduleUpdateObject.html @@ -1,6 +1,6 @@ -CampaignsTriggerScheduleUpdateObject | braze-api

    Interface CampaignsTriggerScheduleUpdateObject

    Request body for update scheduled API-triggered campaigns.

    +CampaignsTriggerScheduleUpdateObject | braze-api

    Interface CampaignsTriggerScheduleUpdateObject

    Request body for update scheduled API-triggered campaigns.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_campaigns/#request-body

    -
    interface CampaignsTriggerScheduleUpdateObject {
        campaign_id: string;
        schedule: ScheduleObject;
        schedule_id: string;
    }

    Properties

    campaign_id +
    interface CampaignsTriggerScheduleUpdateObject {
        campaign_id: string;
        schedule: ScheduleObject;
        schedule_id: string;
    }

    Properties

    campaign_id schedule schedule_id -

    Properties

    campaign_id

    campaign_id: string

    schedule

    schedule: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    campaign_id

    campaign_id: string

    schedule

    schedule: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CampaignsTriggerSendObject.html b/interfaces/CampaignsTriggerSendObject.html index 6d1dccbb..fd4bddcc 100644 --- a/interfaces/CampaignsTriggerSendObject.html +++ b/interfaces/CampaignsTriggerSendObject.html @@ -1,9 +1,9 @@ -CampaignsTriggerSendObject | braze-api

    Interface CampaignsTriggerSendObject

    Request body for sending campaign messages via API-triggered delivery.

    +CampaignsTriggerSendObject | braze-api

    Interface CampaignsTriggerSendObject

    Request body for sending campaign messages via API-triggered delivery.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/#request-body

    -
    interface CampaignsTriggerSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        send_id?: string;
        trigger_properties?: object;
    }

    Hierarchy (view full)

    Properties

    audience? +
    interface CampaignsTriggerSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        send_id?: string;
        trigger_properties?: object;
    }

    Hierarchy (view full)

    Properties

    audience? broadcast? campaign_id recipients? send_id? trigger_properties? -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    campaign_id

    campaign_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Optionalsend_id

    send_id?: string

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    campaign_id

    campaign_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Optionalsend_id

    send_id?: string

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasListParameters.html b/interfaces/CanvasListParameters.html index 9ae19a87..a66f16ff 100644 --- a/interfaces/CanvasListParameters.html +++ b/interfaces/CanvasListParameters.html @@ -1,7 +1,7 @@ -CanvasListParameters | braze-api

    Interface CanvasListParameters

    Request parameters for canvases list.

    +CanvasListParameters | braze-api

    Interface CanvasListParameters

    Request parameters for canvases list.

    https://www.braze.com/docs/api/endpoints/export/canvas/get_canvases/#request-parameters

    -
    interface CanvasListParameters {
        include_archived?: boolean;
        last_edit.time[gt]?: string;
        page?: number;
        sort_direction?: string;
    }

    Properties

    include_archived? +
    interface CanvasListParameters {
        include_archived?: boolean;
        last_edit.time[gt]?: string;
        page?: number;
        sort_direction?: string;
    }

    Properties

    include_archived? last_edit.time[gt]? page? sort_direction? -

    Properties

    Optionalinclude_archived

    include_archived?: boolean

    Optionallast_edit.time[gt]

    last_edit.time[gt]?: string

    Optionalpage

    page?: number

    Optionalsort_direction

    sort_direction?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalinclude_archived

    include_archived?: boolean

    Optionallast_edit.time[gt]

    last_edit.time[gt]?: string

    Optionalpage

    page?: number

    Optionalsort_direction

    sort_direction?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasListResponse.html b/interfaces/CanvasListResponse.html index 844ae081..f727f190 100644 --- a/interfaces/CanvasListResponse.html +++ b/interfaces/CanvasListResponse.html @@ -1,6 +1,6 @@ -CanvasListResponse | braze-api

    Interface CanvasListResponse

    Response body for canvases list.

    +CanvasListResponse | braze-api

    Interface CanvasListResponse

    Response body for canvases list.

    https://www.braze.com/docs/api/endpoints/export/canvas/get_canvases/#response

    -
    interface CanvasListResponse {
        canvases: {
            id: string;
            last_edited: string;
            name: string;
            tags: string[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CanvasListResponse

    Properties

    canvases +
    interface CanvasListResponse {
        canvases: {
            id: string;
            last_edited: string;
            name: string;
            tags: string[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CanvasListResponse

    Properties

    canvases errors? message -

    Properties

    canvases

    canvases: {
        id: string;
        last_edited: string;
        name: string;
        tags: string[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    canvases

    canvases: {
        id: string;
        last_edited: string;
        name: string;
        tags: string[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasTriggerScheduleCreatResponse.html b/interfaces/CanvasTriggerScheduleCreatResponse.html index 3170de45..07bb96ff 100644 --- a/interfaces/CanvasTriggerScheduleCreatResponse.html +++ b/interfaces/CanvasTriggerScheduleCreatResponse.html @@ -1,7 +1,7 @@ -CanvasTriggerScheduleCreatResponse | braze-api

    Interface CanvasTriggerScheduleCreatResponse

    Response body for schedule API-triggered canvases.

    +CanvasTriggerScheduleCreatResponse | braze-api

    Interface CanvasTriggerScheduleCreatResponse

    Response body for schedule API-triggered canvases.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases/#request-body

    -
    interface CanvasTriggerScheduleCreatResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        schedule_id: string;
    }

    Hierarchy

    • ServerResponse
      • CanvasTriggerScheduleCreatResponse

    Properties

    dispatch_id +
    interface CanvasTriggerScheduleCreatResponse {
        dispatch_id: string;
        errors?: string[];
        message: string;
        schedule_id: string;
    }

    Hierarchy

    • ServerResponse
      • CanvasTriggerScheduleCreatResponse

    Properties

    dispatch_id errors? message schedule_id -

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    dispatch_id

    dispatch_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasTriggerScheduleCreateObject.html b/interfaces/CanvasTriggerScheduleCreateObject.html index de7ecdc6..3fd8754c 100644 --- a/interfaces/CanvasTriggerScheduleCreateObject.html +++ b/interfaces/CanvasTriggerScheduleCreateObject.html @@ -1,9 +1,9 @@ -CanvasTriggerScheduleCreateObject | braze-api

    Interface CanvasTriggerScheduleCreateObject

    Request body for schedule API-triggered canvases.

    +CanvasTriggerScheduleCreateObject | braze-api

    Interface CanvasTriggerScheduleCreateObject

    Request body for schedule API-triggered canvases.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases/#request-body

    -
    interface CanvasTriggerScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        canvas_entry_properties?: object;
        canvas_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        schedule: ScheduleObject;
    }

    Hierarchy (view full)

    Properties

    audience? +
    interface CanvasTriggerScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        canvas_entry_properties?: object;
        canvas_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        schedule: ScheduleObject;
    }

    Hierarchy (view full)

    Properties

    audience? broadcast? canvas_entry_properties? canvas_id recipients? schedule -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcanvas_entry_properties

    canvas_entry_properties?: object

    canvas_id

    canvas_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    schedule

    schedule: ScheduleObject

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcanvas_entry_properties

    canvas_entry_properties?: object

    canvas_id

    canvas_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    schedule

    schedule: ScheduleObject

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasTriggerScheduleDeleteObject.html b/interfaces/CanvasTriggerScheduleDeleteObject.html index bde503c1..a9affa3e 100644 --- a/interfaces/CanvasTriggerScheduleDeleteObject.html +++ b/interfaces/CanvasTriggerScheduleDeleteObject.html @@ -1,5 +1,5 @@ -CanvasTriggerScheduleDeleteObject | braze-api

    Interface CanvasTriggerScheduleDeleteObject

    Request body for delete scheduled API-triggered canvases.

    +CanvasTriggerScheduleDeleteObject | braze-api

    Interface CanvasTriggerScheduleDeleteObject

    Request body for delete scheduled API-triggered canvases.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_canvases/#request-body

    -
    interface CanvasTriggerScheduleDeleteObject {
        canvas_id: string;
        schedule_id: string;
    }

    Properties

    canvas_id +
    interface CanvasTriggerScheduleDeleteObject {
        canvas_id: string;
        schedule_id: string;
    }

    Properties

    canvas_id schedule_id -

    Properties

    canvas_id

    canvas_id: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    canvas_id

    canvas_id: string

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasTriggerScheduleUpdateObject.html b/interfaces/CanvasTriggerScheduleUpdateObject.html index a70f8e9e..3bd1aa06 100644 --- a/interfaces/CanvasTriggerScheduleUpdateObject.html +++ b/interfaces/CanvasTriggerScheduleUpdateObject.html @@ -1,6 +1,6 @@ -CanvasTriggerScheduleUpdateObject | braze-api

    Interface CanvasTriggerScheduleUpdateObject

    Request body for update scheduled API-triggered canvases.

    +CanvasTriggerScheduleUpdateObject | braze-api

    Interface CanvasTriggerScheduleUpdateObject

    Request body for update scheduled API-triggered canvases.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_canvases/#request-body

    -
    interface CanvasTriggerScheduleUpdateObject {
        canvas_id: string;
        schedule: ScheduleObject;
        schedule_id: string;
    }

    Properties

    canvas_id +
    interface CanvasTriggerScheduleUpdateObject {
        canvas_id: string;
        schedule: ScheduleObject;
        schedule_id: string;
    }

    Properties

    canvas_id schedule schedule_id -

    Properties

    canvas_id

    canvas_id: string

    schedule

    schedule: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    canvas_id

    canvas_id: string

    schedule

    schedule: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CanvasTriggerSendObject.html b/interfaces/CanvasTriggerSendObject.html index ddc5d664..fe365b07 100644 --- a/interfaces/CanvasTriggerSendObject.html +++ b/interfaces/CanvasTriggerSendObject.html @@ -1,8 +1,8 @@ -CanvasTriggerSendObject | braze-api

    Interface CanvasTriggerSendObject

    Request body for sending Canvas messages via API-triggered delivery.

    +CanvasTriggerSendObject | braze-api

    Interface CanvasTriggerSendObject

    Request body for sending Canvas messages via API-triggered delivery.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_canvases/#request-body

    -
    interface CanvasTriggerSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        canvas_entry_properties?: object;
        canvas_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
    }

    Hierarchy (view full)

    Properties

    audience? +
    interface CanvasTriggerSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        canvas_entry_properties?: object;
        canvas_id: string;
        recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
    }

    Hierarchy (view full)

    Properties

    audience? broadcast? canvas_entry_properties? canvas_id recipients? -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcanvas_entry_properties

    canvas_entry_properties?: object

    canvas_id

    canvas_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcanvas_entry_properties

    canvas_entry_properties?: object

    canvas_id

    canvas_id: string

    Optionalrecipients

    recipients?: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CatalogListItemBody.html b/interfaces/CatalogListItemBody.html index e4250fce..eeda5d21 100644 --- a/interfaces/CatalogListItemBody.html +++ b/interfaces/CatalogListItemBody.html @@ -1,5 +1,5 @@ -CatalogListItemBody | braze-api

    Interface CatalogListItemBody

    Request body for catalog list items.

    +CatalogListItemBody | braze-api

    Interface CatalogListItemBody

    Request body for catalog list items.

    https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/

    -
    interface CatalogListItemBody {
        catalog_name: string;
        item_id: string;
    }

    Properties

    catalog_name +
    interface CatalogListItemBody {
        catalog_name: string;
        item_id: string;
    }

    Properties

    catalog_name item_id -

    Properties

    catalog_name

    catalog_name: string

    item_id

    item_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    catalog_name

    catalog_name: string

    item_id

    item_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CatalogListItemResponse.html b/interfaces/CatalogListItemResponse.html index e1ee4d52..14cd033e 100644 --- a/interfaces/CatalogListItemResponse.html +++ b/interfaces/CatalogListItemResponse.html @@ -1,6 +1,6 @@ -CatalogListItemResponse | braze-api

    Interface CatalogListItemResponse<T>

    Response body for catalog list items.

    +CatalogListItemResponse | braze-api

    Interface CatalogListItemResponse<T>

    Response body for catalog list items.

    https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/

    -
    interface CatalogListItemResponse<T> {
        errors?: string[];
        items: [T];
        message: string;
    }

    Type Parameters

    Hierarchy

    • ServerResponse
      • CatalogListItemResponse

    Properties

    errors? +
    interface CatalogListItemResponse<T> {
        errors?: string[];
        items: [T];
        message: string;
    }

    Type Parameters

    Hierarchy

    • ServerResponse
      • CatalogListItemResponse

    Properties

    errors? items message -

    Properties

    Optionalerrors

    errors?: string[]

    items

    items: [T]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalerrors

    errors?: string[]

    items

    items: [T]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CatalogListItemsBody.html b/interfaces/CatalogListItemsBody.html index c1be8a89..7f5b9c38 100644 --- a/interfaces/CatalogListItemsBody.html +++ b/interfaces/CatalogListItemsBody.html @@ -1,5 +1,5 @@ -CatalogListItemsBody | braze-api

    Interface CatalogListItemsBody

    Request body for catalog list items.

    +CatalogListItemsBody | braze-api

    Interface CatalogListItemsBody

    Request body for catalog list items.

    https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/

    -
    interface CatalogListItemsBody {
        catalog_name: string;
        max_pages?: number;
    }

    Properties

    catalog_name +
    interface CatalogListItemsBody {
        catalog_name: string;
        max_pages?: number;
    }

    Properties

    catalog_name max_pages? -

    Properties

    catalog_name

    catalog_name: string

    Optionalmax_pages

    max_pages?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    catalog_name

    catalog_name: string

    Optionalmax_pages

    max_pages?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CatalogListItemsResponse.html b/interfaces/CatalogListItemsResponse.html index d3558e54..4175017e 100644 --- a/interfaces/CatalogListItemsResponse.html +++ b/interfaces/CatalogListItemsResponse.html @@ -1,6 +1,6 @@ -CatalogListItemsResponse | braze-api

    Interface CatalogListItemsResponse<T>

    Response body for catalog list items.

    +CatalogListItemsResponse | braze-api

    Interface CatalogListItemsResponse<T>

    Response body for catalog list items.

    https://www.braze.com/docs/api/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/

    -
    interface CatalogListItemsResponse<T> {
        errors?: string[];
        items: T[];
        message: string;
    }

    Type Parameters

    Hierarchy

    • ServerResponse
      • CatalogListItemsResponse

    Properties

    errors? +
    interface CatalogListItemsResponse<T> {
        errors?: string[];
        items: T[];
        message: string;
    }

    Type Parameters

    Hierarchy

    • ServerResponse
      • CatalogListItemsResponse

    Properties

    errors? items message -

    Properties

    Optionalerrors

    errors?: string[]

    items

    items: T[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalerrors

    errors?: string[]

    items

    items: T[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CatalogListResponse.html b/interfaces/CatalogListResponse.html index 33524722..779ad259 100644 --- a/interfaces/CatalogListResponse.html +++ b/interfaces/CatalogListResponse.html @@ -1,6 +1,6 @@ -CatalogListResponse | braze-api

    Interface CatalogListResponse

    Response body for catalog list.

    +CatalogListResponse | braze-api

    Interface CatalogListResponse

    Response body for catalog list.

    https://www.braze.com/docs/api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/

    -
    interface CatalogListResponse {
        catalogs: {
            description: string;
            fields: {
                name: string;
                type: string;
            }[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CatalogListResponse

    Properties

    catalogs +
    interface CatalogListResponse {
        catalogs: {
            description: string;
            fields: {
                name: string;
                type: string;
            }[];
        }[];
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • CatalogListResponse

    Properties

    catalogs errors? message -

    Properties

    catalogs

    catalogs: {
        description: string;
        fields: {
            name: string;
            type: string;
        }[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    catalogs

    catalogs: {
        description: string;
        fields: {
            name: string;
            type: string;
        }[];
    }[]

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ConnectedAudienceObject.html b/interfaces/ConnectedAudienceObject.html index 72b19d5d..bf53d913 100644 --- a/interfaces/ConnectedAudienceObject.html +++ b/interfaces/ConnectedAudienceObject.html @@ -1,5 +1,5 @@ -ConnectedAudienceObject | braze-api

    Interface ConnectedAudienceObject

    A Connected Audience Object is a selector that identifies the audience to send the message to. It is composed of either a single Connected Audience Filter or several Connected Audience Filters in a logical expression using either AND or OR operators.

    +ConnectedAudienceObject | braze-api

    Interface ConnectedAudienceObject

    A Connected Audience Object is a selector that identifies the audience to send the message to. It is composed of either a single Connected Audience Filter or several Connected Audience Filters in a logical expression using either AND or OR operators.

    https://www.braze.com/docs/api/objects_filters/connected_audience/

    -
    interface ConnectedAudienceObject {
        AND?: (ConnectedAudienceObject | ConnectedAudienceFilter)[];
        OR?: (ConnectedAudienceObject | ConnectedAudienceFilter)[];
    }

    Properties

    AND? +
    interface ConnectedAudienceObject {
        AND?: (ConnectedAudienceObject | ConnectedAudienceFilter)[];
        OR?: (ConnectedAudienceObject | ConnectedAudienceFilter)[];
    }

    Properties

    AND? OR? -

    Properties

    OptionalAND

    AND?: (ConnectedAudienceObject | ConnectedAudienceFilter)[]

    OptionalOR

    OR?: (ConnectedAudienceObject | ConnectedAudienceFilter)[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalAND

    AND?: (ConnectedAudienceObject | ConnectedAudienceFilter)[]

    OptionalOR

    OR?: (ConnectedAudienceObject | ConnectedAudienceFilter)[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ContentBlockBody.html b/interfaces/ContentBlockBody.html index e213bc6d..52d5ed53 100644 --- a/interfaces/ContentBlockBody.html +++ b/interfaces/ContentBlockBody.html @@ -1,5 +1,5 @@ -ContentBlockBody | braze-api

    Interface ContentBlockBody

    Request body for content block.

    +ContentBlockBody | braze-api

    Interface ContentBlockBody

    Request body for content block.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/

    -
    interface ContentBlockBody {
        content_block_id: string;
        include_inclusion_data?: boolean;
    }

    Properties

    content_block_id +
    interface ContentBlockBody {
        content_block_id: string;
        include_inclusion_data?: boolean;
    }

    Properties

    content_block_id include_inclusion_data? -

    Properties

    content_block_id

    content_block_id: string

    Optionalinclude_inclusion_data

    include_inclusion_data?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    content_block_id

    content_block_id: string

    Optionalinclude_inclusion_data

    include_inclusion_data?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ContentBlockListBody.html b/interfaces/ContentBlockListBody.html index f8302af1..9ad1f055 100644 --- a/interfaces/ContentBlockListBody.html +++ b/interfaces/ContentBlockListBody.html @@ -1,7 +1,7 @@ -ContentBlockListBody | braze-api

    Interface ContentBlockListBody

    Request body for content block list.

    +ContentBlockListBody | braze-api

    Interface ContentBlockListBody

    Request body for content block list.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/

    -
    interface ContentBlockListBody {
        limit?: number;
        modified_after?: string;
        modified_before?: string;
        offset?: number;
    }

    Properties

    limit? +
    interface ContentBlockListBody {
        limit?: number;
        modified_after?: string;
        modified_before?: string;
        offset?: number;
    }

    Properties

    limit? modified_after? modified_before? offset? -

    Properties

    Optionallimit

    limit?: number

    Optionalmodified_after

    modified_after?: string

    Optionalmodified_before

    modified_before?: string

    Optionaloffset

    offset?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionallimit

    limit?: number

    Optionalmodified_after

    modified_after?: string

    Optionalmodified_before

    modified_before?: string

    Optionaloffset

    offset?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ContentBlockListResponse.html b/interfaces/ContentBlockListResponse.html index 691b1611..ee5a4877 100644 --- a/interfaces/ContentBlockListResponse.html +++ b/interfaces/ContentBlockListResponse.html @@ -1,7 +1,7 @@ -ContentBlockListResponse | braze-api

    Interface ContentBlockListResponse

    Response body for content block list.

    +ContentBlockListResponse | braze-api

    Interface ContentBlockListResponse

    Response body for content block list.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/

    -
    interface ContentBlockListResponse {
        content_blocks: {
            content_block_id: string;
            content_type: string;
            created_at: string;
            inclusion_count: number;
            last_edited: string;
            liquid_tag: string;
            name: string;
            tags: string[];
        }[];
        count: number;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • ContentBlockListResponse

    Properties

    content_blocks +
    interface ContentBlockListResponse {
        content_blocks: {
            content_block_id: string;
            content_type: string;
            created_at: string;
            inclusion_count: number;
            last_edited: string;
            liquid_tag: string;
            name: string;
            tags: string[];
        }[];
        count: number;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • ContentBlockListResponse

    Properties

    content_blocks count errors? message -

    Properties

    content_blocks

    content_blocks: {
        content_block_id: string;
        content_type: string;
        created_at: string;
        inclusion_count: number;
        last_edited: string;
        liquid_tag: string;
        name: string;
        tags: string[];
    }[]

    count

    count: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    content_blocks

    content_blocks: {
        content_block_id: string;
        content_type: string;
        created_at: string;
        inclusion_count: number;
        last_edited: string;
        liquid_tag: string;
        name: string;
        tags: string[];
    }[]

    count

    count: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ContentBlockResponse.html b/interfaces/ContentBlockResponse.html index 0ed5a5d7..576be761 100644 --- a/interfaces/ContentBlockResponse.html +++ b/interfaces/ContentBlockResponse.html @@ -1,6 +1,6 @@ -ContentBlockResponse | braze-api

    Interface ContentBlockResponse

    Response body for content block.

    +ContentBlockResponse | braze-api

    Interface ContentBlockResponse

    Response body for content block.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/

    -
    interface ContentBlockResponse {
        content: string;
        content_block_id: string;
        content_type: string;
        created_at: string;
        description: string;
        errors?: string[];
        inclusion_count: number;
        inclusion_data: string[];
        last_edited: string;
        message: string;
        name: string;
        tags: string[];
    }

    Hierarchy

    • ServerResponse
      • ContentBlockResponse

    Properties

    content +
    interface ContentBlockResponse {
        content: string;
        content_block_id: string;
        content_type: string;
        created_at: string;
        description: string;
        errors?: string[];
        inclusion_count: number;
        inclusion_data: string[];
        last_edited: string;
        message: string;
        name: string;
        tags: string[];
    }

    Hierarchy

    • ServerResponse
      • ContentBlockResponse

    Properties

    content content_block_id content_type created_at @@ -12,4 +12,4 @@ message name tags -

    Properties

    content

    content: string

    content_block_id

    content_block_id: string

    content_type

    content_type: string

    created_at

    created_at: string

    description

    description: string

    Optionalerrors

    errors?: string[]

    inclusion_count

    inclusion_count: number

    inclusion_data

    inclusion_data: string[]

    last_edited

    last_edited: string

    message

    message: string

    name

    name: string

    tags

    tags: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    content

    content: string

    content_block_id

    content_block_id: string

    content_type

    content_type: string

    created_at

    created_at: string

    description

    description: string

    Optionalerrors

    errors?: string[]

    inclusion_count

    inclusion_count: number

    inclusion_data

    inclusion_data: string[]

    last_edited

    last_edited: string

    message

    message: string

    name

    name: string

    tags

    tags: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CreateContentBlockBody.html b/interfaces/CreateContentBlockBody.html index 836044ff..626b861f 100644 --- a/interfaces/CreateContentBlockBody.html +++ b/interfaces/CreateContentBlockBody.html @@ -1,8 +1,8 @@ -CreateContentBlockBody | braze-api

    Interface CreateContentBlockBody

    Request body for create content block.

    +CreateContentBlockBody | braze-api

    Interface CreateContentBlockBody

    Request body for create content block.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block/

    -
    interface CreateContentBlockBody {
        content: string;
        description?: string;
        name: string;
        state?: "active" | "draft";
        tags?: string[];
    }

    Properties

    content +
    interface CreateContentBlockBody {
        content: string;
        description?: string;
        name: string;
        state?: "active" | "draft";
        tags?: string[];
    }

    Properties

    content description? name state? tags? -

    Properties

    content

    content: string

    Optionaldescription

    description?: string

    name

    name: string

    Optionalstate

    state?: "active" | "draft"

    Optionaltags

    tags?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    content

    content: string

    Optionaldescription

    description?: string

    name

    name: string

    Optionalstate

    state?: "active" | "draft"

    Optionaltags

    tags?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CreateEmailTemplateBody.html b/interfaces/CreateEmailTemplateBody.html index ae95e0f8..1a150e37 100644 --- a/interfaces/CreateEmailTemplateBody.html +++ b/interfaces/CreateEmailTemplateBody.html @@ -1,10 +1,10 @@ -CreateEmailTemplateBody | braze-api

    Interface CreateEmailTemplateBody

    Request body for create/update email template.

    +CreateEmailTemplateBody | braze-api

    Interface CreateEmailTemplateBody

    Request body for create/update email template.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/post_create_email_template/

    -
    interface CreateEmailTemplateBody {
        body: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags?: string[];
        template_name: string;
    }

    Hierarchy (view full)

    Properties

    body +
    interface CreateEmailTemplateBody {
        body: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags?: string[];
        template_name: string;
    }

    Hierarchy (view full)

    Properties

    body plaintext_body? preheader? should_inline_css? subject tags? template_name -

    Properties

    body

    body: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    Optionaltags

    tags?: string[]

    template_name

    template_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    Optionaltags

    tags?: string[]

    template_name

    template_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailBlacklistObject.html b/interfaces/EmailBlacklistObject.html index 79b1320c..287a60c5 100644 --- a/interfaces/EmailBlacklistObject.html +++ b/interfaces/EmailBlacklistObject.html @@ -1,4 +1,4 @@ -EmailBlacklistObject | braze-api

    Interface EmailBlacklistObject

    Request body for blacklist emails.

    +EmailBlacklistObject | braze-api

    Interface EmailBlacklistObject

    Request body for blacklist emails.

    https://www.braze.com/docs/api/endpoints/email/post_blacklist/#request-body

    -
    interface EmailBlacklistObject {
        email: string | string[];
    }

    Properties

    email -

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface EmailBlacklistObject {
        email: string | string[];
    }

    Properties

    email +

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailBounceRemoveObject.html b/interfaces/EmailBounceRemoveObject.html index 42bf8710..13427d83 100644 --- a/interfaces/EmailBounceRemoveObject.html +++ b/interfaces/EmailBounceRemoveObject.html @@ -1,4 +1,4 @@ -EmailBounceRemoveObject | braze-api

    Interface EmailBounceRemoveObject

    Request body for remove hard bounces.

    +EmailBounceRemoveObject | braze-api

    Interface EmailBounceRemoveObject

    Request body for remove hard bounces.

    https://www.braze.com/docs/api/endpoints/email/post_remove_hard_bounces/#request-body

    -
    interface EmailBounceRemoveObject {
        email: string | string[];
    }

    Properties

    email -

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface EmailBounceRemoveObject {
        email: string | string[];
    }

    Properties

    email +

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailSpamRemoveObject.html b/interfaces/EmailSpamRemoveObject.html index 405cdacd..38f74020 100644 --- a/interfaces/EmailSpamRemoveObject.html +++ b/interfaces/EmailSpamRemoveObject.html @@ -1,4 +1,4 @@ -EmailSpamRemoveObject | braze-api

    Interface EmailSpamRemoveObject

    Request body for remove email addresses from spam list.

    +EmailSpamRemoveObject | braze-api

    Interface EmailSpamRemoveObject

    Request body for remove email addresses from spam list.

    https://www.braze.com/docs/api/endpoints/email/post_remove_spam/#request-body

    -
    interface EmailSpamRemoveObject {
        email: string | string[];
    }

    Properties

    email -

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface EmailSpamRemoveObject {
        email: string | string[];
    }

    Properties

    email +

    Properties

    email

    email: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailTemplateBody.html b/interfaces/EmailTemplateBody.html index e620f6eb..ade38071 100644 --- a/interfaces/EmailTemplateBody.html +++ b/interfaces/EmailTemplateBody.html @@ -1,4 +1,4 @@ -EmailTemplateBody | braze-api

    Interface EmailTemplateBody

    Request body for email template.

    +EmailTemplateBody | braze-api

    Interface EmailTemplateBody

    Request body for email template.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/get_see_email_template_information/

    -
    interface EmailTemplateBody {
        email_template_id: string;
    }

    Properties

    email_template_id -

    Properties

    email_template_id

    email_template_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface EmailTemplateBody {
        email_template_id: string;
    }

    Properties

    email_template_id +

    Properties

    email_template_id

    email_template_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailTemplateListBody.html b/interfaces/EmailTemplateListBody.html index bcadde63..37f5f95d 100644 --- a/interfaces/EmailTemplateListBody.html +++ b/interfaces/EmailTemplateListBody.html @@ -1,7 +1,7 @@ -EmailTemplateListBody | braze-api

    Interface EmailTemplateListBody

    Request body for email template list.

    +EmailTemplateListBody | braze-api

    Interface EmailTemplateListBody

    Request body for email template list.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/get_list_email_templates/

    -
    interface EmailTemplateListBody {
        limit?: number;
        modified_after?: string;
        modified_before?: string;
        offset?: number;
    }

    Properties

    limit? +
    interface EmailTemplateListBody {
        limit?: number;
        modified_after?: string;
        modified_before?: string;
        offset?: number;
    }

    Properties

    limit? modified_after? modified_before? offset? -

    Properties

    Optionallimit

    limit?: number

    Optionalmodified_after

    modified_after?: string

    Optionalmodified_before

    modified_before?: string

    Optionaloffset

    offset?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionallimit

    limit?: number

    Optionalmodified_after

    modified_after?: string

    Optionalmodified_before

    modified_before?: string

    Optionaloffset

    offset?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailTemplateListResponse.html b/interfaces/EmailTemplateListResponse.html index 2f6e037d..b4f6a760 100644 --- a/interfaces/EmailTemplateListResponse.html +++ b/interfaces/EmailTemplateListResponse.html @@ -1,7 +1,7 @@ -EmailTemplateListResponse | braze-api

    Interface EmailTemplateListResponse

    Response body for email template list.

    +EmailTemplateListResponse | braze-api

    Interface EmailTemplateListResponse

    Response body for email template list.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/get_list_email_templates/

    -
    interface EmailTemplateListResponse {
        count: number;
        errors?: string[];
        message: string;
        templates: {
            created_at: string;
            email_template_id: string;
            tags: string[];
            template_name: string;
            updated_at: string;
        }[];
    }

    Hierarchy

    • ServerResponse
      • EmailTemplateListResponse

    Properties

    count +
    interface EmailTemplateListResponse {
        count: number;
        errors?: string[];
        message: string;
        templates: {
            created_at: string;
            email_template_id: string;
            tags: string[];
            template_name: string;
            updated_at: string;
        }[];
    }

    Hierarchy

    • ServerResponse
      • EmailTemplateListResponse

    Properties

    count errors? message templates -

    Properties

    count

    count: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    templates

    templates: {
        created_at: string;
        email_template_id: string;
        tags: string[];
        template_name: string;
        updated_at: string;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    count

    count: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    templates

    templates: {
        created_at: string;
        email_template_id: string;
        tags: string[];
        template_name: string;
        updated_at: string;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/EmailTemplateResponse.html b/interfaces/EmailTemplateResponse.html index 6e598986..43229d12 100644 --- a/interfaces/EmailTemplateResponse.html +++ b/interfaces/EmailTemplateResponse.html @@ -1,6 +1,6 @@ -EmailTemplateResponse | braze-api

    Interface EmailTemplateResponse

    Response body for email template.

    +EmailTemplateResponse | braze-api

    Interface EmailTemplateResponse

    Response body for email template.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/get_see_email_template_information/

    -
    interface EmailTemplateResponse {
        body?: string;
        created_at: string;
        description: string;
        email_template_id: string;
        errors?: string[];
        message: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags: string;
        template_name: string;
        updated_at: string;
    }

    Hierarchy

    • ServerResponse
      • EmailTemplateResponse

    Properties

    body? +
    interface EmailTemplateResponse {
        body?: string;
        created_at: string;
        description: string;
        email_template_id: string;
        errors?: string[];
        message: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags: string;
        template_name: string;
        updated_at: string;
    }

    Hierarchy

    • ServerResponse
      • EmailTemplateResponse

    Properties

    body? created_at description email_template_id @@ -13,4 +13,4 @@ tags template_name updated_at -

    Properties

    Optionalbody

    body?: string

    created_at

    created_at: string

    description

    description: string

    email_template_id

    email_template_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    tags

    tags: string

    template_name

    template_name: string

    updated_at

    updated_at: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalbody

    body?: string

    created_at

    created_at: string

    description

    description: string

    email_template_id

    email_template_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    tags

    tags: string

    template_name

    template_name: string

    updated_at

    updated_at: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MessagesObject.html b/interfaces/MessagesObject.html index aee0dc60..4f501934 100644 --- a/interfaces/MessagesObject.html +++ b/interfaces/MessagesObject.html @@ -1,6 +1,6 @@ -MessagesObject | braze-api

    Interface MessagesObject

    Messaging objects.

    +MessagesObject | braze-api

    Interface MessagesObject

    Messaging objects.

    https://www.braze.com/docs/api/objects_filters/#messaging-objects

    -
    interface MessagesObject {
        android_push?: AndroidPushObject;
        apple_push?: ApplePushObject;
        content_card?: object;
        email?: EmailObjectWithBody | EmailObjectWithEmailTemplateId;
        kindle_push?: object;
        sms?: object;
        web_push?: object;
        webhook?: object;
        windows_phone8_push?: object;
        windows_universal_push?: object;
    }

    Properties

    android_push? +
    interface MessagesObject {
        android_push?: AndroidPushObject;
        apple_push?: ApplePushObject;
        content_card?: object;
        email?: EmailObjectWithBody | EmailObjectWithEmailTemplateId;
        kindle_push?: object;
        sms?: object;
        web_push?: object;
        webhook?: object;
        windows_phone8_push?: object;
        windows_universal_push?: object;
    }

    Properties

    android_push? apple_push? content_card? email? @@ -10,4 +10,4 @@ webhook? windows_phone8_push? windows_universal_push? -

    Properties

    Optionalandroid_push

    android_push?: AndroidPushObject

    Optionalapple_push

    apple_push?: ApplePushObject

    Optionalcontent_card

    content_card?: object

    Optionalemail

    email?: EmailObjectWithBody | EmailObjectWithEmailTemplateId

    Optionalkindle_push

    kindle_push?: object

    Optionalsms

    sms?: object

    Optionalweb_push

    web_push?: object

    Optionalwebhook

    webhook?: object

    Optionalwindows_phone8_push

    windows_phone8_push?: object

    Optionalwindows_universal_push

    windows_universal_push?: object

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalandroid_push

    android_push?: AndroidPushObject

    Optionalapple_push

    apple_push?: ApplePushObject

    Optionalcontent_card

    content_card?: object

    Optionalemail

    email?: EmailObjectWithBody | EmailObjectWithEmailTemplateId

    Optionalkindle_push

    kindle_push?: object

    Optionalsms

    sms?: object

    Optionalweb_push

    web_push?: object

    Optionalwebhook

    webhook?: object

    Optionalwindows_phone8_push

    windows_phone8_push?: object

    Optionalwindows_universal_push

    windows_universal_push?: object

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MessagesScheduleCreateObject.html b/interfaces/MessagesScheduleCreateObject.html index 638ff60b..2e480f82 100644 --- a/interfaces/MessagesScheduleCreateObject.html +++ b/interfaces/MessagesScheduleCreateObject.html @@ -1,6 +1,6 @@ -MessagesScheduleCreateObject | braze-api

    Interface MessagesScheduleCreateObject

    Request body for create scheduled messages.

    +MessagesScheduleCreateObject | braze-api

    Interface MessagesScheduleCreateObject

    Request body for create scheduled messages.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_messages/#request-body

    -
    interface MessagesScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id?: string;
        external_user_ids?: string[];
        messages?: MessagesObject;
        override_messaging_limits?: boolean;
        recipient_subscription_state?: string;
        schedule: ScheduleObject;
        segment_id?: string;
        send_id?: string;
        user_aliases?: UserAlias[];
    }

    Hierarchy

    Properties

    audience? +
    interface MessagesScheduleCreateObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id?: string;
        external_user_ids?: string[];
        messages?: MessagesObject;
        override_messaging_limits?: boolean;
        recipient_subscription_state?: string;
        schedule: ScheduleObject;
        segment_id?: string;
        send_id?: string;
        user_aliases?: UserAlias[];
    }

    Hierarchy

    Properties

    audience? broadcast? campaign_id? external_user_ids? @@ -11,4 +11,4 @@ segment_id? send_id? user_aliases? -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcampaign_id

    campaign_id?: string

    Optionalexternal_user_ids

    external_user_ids?: string[]

    Optionalmessages

    messages?: MessagesObject

    Optionaloverride_messaging_limits

    override_messaging_limits?: boolean

    Optionalrecipient_subscription_state

    recipient_subscription_state?: string

    schedule

    schedule: ScheduleObject

    Optionalsegment_id

    segment_id?: string

    Optionalsend_id

    send_id?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcampaign_id

    campaign_id?: string

    Optionalexternal_user_ids

    external_user_ids?: string[]

    Optionalmessages

    messages?: MessagesObject

    Optionaloverride_messaging_limits

    override_messaging_limits?: boolean

    Optionalrecipient_subscription_state

    recipient_subscription_state?: string

    schedule

    schedule: ScheduleObject

    Optionalsegment_id

    segment_id?: string

    Optionalsend_id

    send_id?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MessagesScheduleDeleteObject.html b/interfaces/MessagesScheduleDeleteObject.html index 75987f85..62246815 100644 --- a/interfaces/MessagesScheduleDeleteObject.html +++ b/interfaces/MessagesScheduleDeleteObject.html @@ -1,4 +1,4 @@ -MessagesScheduleDeleteObject | braze-api

    Interface MessagesScheduleDeleteObject

    Request body for delete scheduled messages.

    +MessagesScheduleDeleteObject | braze-api

    Interface MessagesScheduleDeleteObject

    Request body for delete scheduled messages.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_delete_scheduled_messages/#request-body

    -
    interface MessagesScheduleDeleteObject {
        schedule_id: string;
    }

    Properties

    schedule_id -

    Properties

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface MessagesScheduleDeleteObject {
        schedule_id: string;
    }

    Properties

    schedule_id +

    Properties

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MessagesScheduleUpdateObject.html b/interfaces/MessagesScheduleUpdateObject.html index 25a14c1b..ce13131d 100644 --- a/interfaces/MessagesScheduleUpdateObject.html +++ b/interfaces/MessagesScheduleUpdateObject.html @@ -1,6 +1,6 @@ -MessagesScheduleUpdateObject | braze-api

    Interface MessagesScheduleUpdateObject

    Request body for update scheduled messages.

    +MessagesScheduleUpdateObject | braze-api

    Interface MessagesScheduleUpdateObject

    Request body for update scheduled messages.

    https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_messages/#request-body

    -
    interface MessagesScheduleUpdateObject {
        messages?: MessagesObject;
        schedule?: ScheduleObject;
        schedule_id: string;
    }

    Properties

    messages? +
    interface MessagesScheduleUpdateObject {
        messages?: MessagesObject;
        schedule?: ScheduleObject;
        schedule_id: string;
    }

    Properties

    messages? schedule? schedule_id -

    Properties

    Optionalmessages

    messages?: MessagesObject

    Optionalschedule

    schedule?: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalmessages

    messages?: MessagesObject

    Optionalschedule

    schedule?: ScheduleObject

    schedule_id

    schedule_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/MessagesSendObject.html b/interfaces/MessagesSendObject.html index 29c02687..7ebe6dfb 100644 --- a/interfaces/MessagesSendObject.html +++ b/interfaces/MessagesSendObject.html @@ -1,6 +1,6 @@ -MessagesSendObject | braze-api

    Interface MessagesSendObject

    Request body for sending messages immediately via API only.

    +MessagesSendObject | braze-api

    Interface MessagesSendObject

    Request body for sending messages immediately via API only.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_messages/#request-parameters

    -
    interface MessagesSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id?: string;
        external_user_ids?: string[];
        messages?: MessagesObject;
        override_frequency_capping?: boolean;
        recipient_subscription_state?: string;
        segment_id?: string;
        send_id?: string;
        user_aliases?: UserAlias[];
    }

    Properties

    audience? +
    interface MessagesSendObject {
        audience?: ConnectedAudienceObject;
        broadcast?: boolean;
        campaign_id?: string;
        external_user_ids?: string[];
        messages?: MessagesObject;
        override_frequency_capping?: boolean;
        recipient_subscription_state?: string;
        segment_id?: string;
        send_id?: string;
        user_aliases?: UserAlias[];
    }

    Properties

    audience? broadcast? campaign_id? external_user_ids? @@ -10,4 +10,4 @@ segment_id? send_id? user_aliases? -

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcampaign_id

    campaign_id?: string

    Optionalexternal_user_ids

    external_user_ids?: string[]

    Optionalmessages

    messages?: MessagesObject

    Optionaloverride_frequency_capping

    override_frequency_capping?: boolean

    Optionalrecipient_subscription_state

    recipient_subscription_state?: string

    Optionalsegment_id

    segment_id?: string

    Optionalsend_id

    send_id?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalaudience

    audience?: ConnectedAudienceObject

    Optionalbroadcast

    broadcast?: boolean

    Optionalcampaign_id

    campaign_id?: string

    Optionalexternal_user_ids

    external_user_ids?: string[]

    Optionalmessages

    messages?: MessagesObject

    Optionaloverride_frequency_capping

    override_frequency_capping?: boolean

    Optionalrecipient_subscription_state

    recipient_subscription_state?: string

    Optionalsegment_id

    segment_id?: string

    Optionalsend_id

    send_id?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PostContentBlockResponse.html b/interfaces/PostContentBlockResponse.html index 15f78e27..46fc2ef7 100644 --- a/interfaces/PostContentBlockResponse.html +++ b/interfaces/PostContentBlockResponse.html @@ -1,9 +1,9 @@ -PostContentBlockResponse | braze-api

    Interface PostContentBlockResponse

    Response body for create/update content block.

    +PostContentBlockResponse | braze-api

    Interface PostContentBlockResponse

    Response body for create/update content block.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block/ https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_update_content_block/

    -
    interface PostContentBlockResponse {
        content_block_id: string;
        created_at: string;
        errors?: string[];
        liquid_tag: string;
        message: "success";
    }

    Hierarchy

    • ServerResponse
      • PostContentBlockResponse

    Properties

    content_block_id +
    interface PostContentBlockResponse {
        content_block_id: string;
        created_at: string;
        errors?: string[];
        liquid_tag: string;
        message: "success";
    }

    Hierarchy

    • ServerResponse
      • PostContentBlockResponse

    Properties

    content_block_id created_at errors? liquid_tag message -

    Properties

    content_block_id

    content_block_id: string

    created_at

    created_at: string

    Optionalerrors

    errors?: string[]

    liquid_tag

    liquid_tag: string

    message

    message: "success"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    content_block_id

    content_block_id: string

    created_at

    created_at: string

    Optionalerrors

    errors?: string[]

    liquid_tag

    liquid_tag: string

    message

    message: "success"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/PostEmailTemplateResponse.html b/interfaces/PostEmailTemplateResponse.html index be9a1594..d7038d47 100644 --- a/interfaces/PostEmailTemplateResponse.html +++ b/interfaces/PostEmailTemplateResponse.html @@ -1,7 +1,7 @@ -PostEmailTemplateResponse | braze-api

    Interface PostEmailTemplateResponse

    Response body for create/update email template.

    +PostEmailTemplateResponse | braze-api

    Interface PostEmailTemplateResponse

    Response body for create/update email template.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/post_create_email_template/ https://www.braze.com/docs/api/endpoints/templates/email_templates/post_update_email_template/

    -
    interface PostEmailTemplateResponse {
        email_template_id: string;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • PostEmailTemplateResponse

    Properties

    email_template_id +
    interface PostEmailTemplateResponse {
        email_template_id: string;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • PostEmailTemplateResponse

    Properties

    email_template_id errors? message -

    Properties

    email_template_id

    email_template_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    email_template_id

    email_template_id: string

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ScheduleObject.html b/interfaces/ScheduleObject.html index 91b2b037..819024e1 100644 --- a/interfaces/ScheduleObject.html +++ b/interfaces/ScheduleObject.html @@ -1,6 +1,6 @@ -ScheduleObject | braze-api

    Interface ScheduleObject

    Schedule object specification.

    +ScheduleObject | braze-api

    Interface ScheduleObject

    Schedule object specification.

    https://www.braze.com/docs/api/objects_filters/schedule_object/

    -
    interface ScheduleObject {
        at_optimal_time?: boolean;
        in_local_time?: boolean;
        time: string;
    }

    Properties

    at_optimal_time? +
    interface ScheduleObject {
        at_optimal_time?: boolean;
        in_local_time?: boolean;
        time: string;
    }

    Properties

    at_optimal_time? in_local_time? time -

    Properties

    Optionalat_optimal_time

    at_optimal_time?: boolean

    Optionalin_local_time

    in_local_time?: boolean

    time

    time: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalat_optimal_time

    at_optimal_time?: boolean

    Optionalin_local_time

    in_local_time?: boolean

    time

    time: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ScheduledBroadcastsObject.html b/interfaces/ScheduledBroadcastsObject.html index f379ddf2..994aec43 100644 --- a/interfaces/ScheduledBroadcastsObject.html +++ b/interfaces/ScheduledBroadcastsObject.html @@ -1,2 +1,2 @@ -ScheduledBroadcastsObject | braze-api

    Interface ScheduledBroadcastsObject

    interface ScheduledBroadcastsObject {
        end_time: string;
    }

    Properties

    end_time -

    Properties

    end_time

    end_time: string

    Settings

    Member Visibility

    On This Page

    Properties
    +ScheduledBroadcastsObject | braze-api

    Interface ScheduledBroadcastsObject

    interface ScheduledBroadcastsObject {
        end_time: string;
    }

    Properties

    end_time +

    Properties

    end_time

    end_time: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ScheduledBroadcastsResponse.html b/interfaces/ScheduledBroadcastsResponse.html index 75425b1b..1d872f66 100644 --- a/interfaces/ScheduledBroadcastsResponse.html +++ b/interfaces/ScheduledBroadcastsResponse.html @@ -1,4 +1,4 @@ -ScheduledBroadcastsResponse | braze-api

    Interface ScheduledBroadcastsResponse

    interface ScheduledBroadcastsResponse {
        errors?: string[];
        message: string;
        scheduled_broadcasts: {
            id: string;
            name: string;
            next_send_time: string;
            schedule_type: string;
            tags: string[];
            type: "Canvas" | "Campaign";
        }[];
    }

    Hierarchy

    • ServerResponse
      • ScheduledBroadcastsResponse

    Properties

    errors? +ScheduledBroadcastsResponse | braze-api

    Interface ScheduledBroadcastsResponse

    interface ScheduledBroadcastsResponse {
        errors?: string[];
        message: string;
        scheduled_broadcasts: {
            id: string;
            name: string;
            next_send_time: string;
            schedule_type: string;
            tags: string[];
            type: "Canvas" | "Campaign";
        }[];
    }

    Hierarchy

    • ServerResponse
      • ScheduledBroadcastsResponse

    Properties

    errors? message scheduled_broadcasts -

    Properties

    Optionalerrors

    errors?: string[]

    message

    message: string

    scheduled_broadcasts

    scheduled_broadcasts: {
        id: string;
        name: string;
        next_send_time: string;
        schedule_type: string;
        tags: string[];
        type: "Canvas" | "Campaign";
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalerrors

    errors?: string[]

    message

    message: string

    scheduled_broadcasts

    scheduled_broadcasts: {
        id: string;
        name: string;
        next_send_time: string;
        schedule_type: string;
        tags: string[];
        type: "Canvas" | "Campaign";
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SendsIdCreateObject.html b/interfaces/SendsIdCreateObject.html index 91a27ac7..a755fa3d 100644 --- a/interfaces/SendsIdCreateObject.html +++ b/interfaces/SendsIdCreateObject.html @@ -1,5 +1,5 @@ -SendsIdCreateObject | braze-api

    Interface SendsIdCreateObject

    Request body for create send IDs.

    +SendsIdCreateObject | braze-api

    Interface SendsIdCreateObject

    Request body for create send IDs.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_create_send_ids/#request-body

    -
    interface SendsIdCreateObject {
        campaign_id: string;
        send_id?: string;
    }

    Properties

    campaign_id +
    interface SendsIdCreateObject {
        campaign_id: string;
        send_id?: string;
    }

    Properties

    campaign_id send_id? -

    Properties

    campaign_id

    campaign_id: string

    Optionalsend_id

    send_id?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    campaign_id

    campaign_id: string

    Optionalsend_id

    send_id?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SubscriptionStatusGetObject.html b/interfaces/SubscriptionStatusGetObject.html index 7dbff518..35a09414 100644 --- a/interfaces/SubscriptionStatusGetObject.html +++ b/interfaces/SubscriptionStatusGetObject.html @@ -1,7 +1,7 @@ -SubscriptionStatusGetObject | braze-api

    Interface SubscriptionStatusGetObject

    Request body for get users’ subscription group status.

    +SubscriptionStatusGetObject | braze-api

    Interface SubscriptionStatusGetObject

    Request body for get users’ subscription group status.

    https://www.braze.com/docs/api/endpoints/subscription_groups/get_list_user_subscription_group_status/#request-parameters

    -
    interface SubscriptionStatusGetObject {
        email?: string | string[];
        external_id?: string | string[];
        phone?: string | string[];
        subscription_group_id: string;
    }

    Properties

    email? +
    interface SubscriptionStatusGetObject {
        email?: string | string[];
        external_id?: string | string[];
        phone?: string | string[];
        subscription_group_id: string;
    }

    Properties

    email? external_id? phone? subscription_group_id -

    Properties

    Optionalemail

    email?: string | string[]

    Optionalexternal_id

    external_id?: string | string[]

    Optionalphone

    phone?: string | string[]

    subscription_group_id

    subscription_group_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalemail

    email?: string | string[]

    Optionalexternal_id

    external_id?: string | string[]

    Optionalphone

    phone?: string | string[]

    subscription_group_id

    subscription_group_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SubscriptionUserStatusObject.html b/interfaces/SubscriptionUserStatusObject.html index e676823f..4d65630f 100644 --- a/interfaces/SubscriptionUserStatusObject.html +++ b/interfaces/SubscriptionUserStatusObject.html @@ -1,8 +1,8 @@ -SubscriptionUserStatusObject | braze-api

    Interface SubscriptionUserStatusObject

    Request body for get users’ subscription groups.

    +SubscriptionUserStatusObject | braze-api

    Interface SubscriptionUserStatusObject

    Request body for get users’ subscription groups.

    https://www.braze.com/docs/api/endpoints/subscription_groups/get_list_user_subscription_groups/#request-parameters

    -
    interface SubscriptionUserStatusObject {
        email?: string | string[];
        external_id?: string | string[];
        limit?: number;
        offset?: number;
        phone?: string | string[];
    }

    Properties

    email? +
    interface SubscriptionUserStatusObject {
        email?: string | string[];
        external_id?: string | string[];
        limit?: number;
        offset?: number;
        phone?: string | string[];
    }

    Properties

    email? external_id? limit? offset? phone? -

    Properties

    Optionalemail

    email?: string | string[]

    Optionalexternal_id

    external_id?: string | string[]

    Optionallimit

    limit?: number

    Optionaloffset

    offset?: number

    Optionalphone

    phone?: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalemail

    email?: string | string[]

    Optionalexternal_id

    external_id?: string | string[]

    Optionallimit

    limit?: number

    Optionaloffset

    offset?: number

    Optionalphone

    phone?: string | string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/SubscriptionUserStatusResponse.html b/interfaces/SubscriptionUserStatusResponse.html index af31f281..ed97411b 100644 --- a/interfaces/SubscriptionUserStatusResponse.html +++ b/interfaces/SubscriptionUserStatusResponse.html @@ -1,5 +1,5 @@ -SubscriptionUserStatusResponse | braze-api

    Interface SubscriptionUserStatusResponse

    interface SubscriptionUserStatusResponse {
        errors?: string[];
        message: string;
        total_count: number;
        users: {
            email: null | string;
            external_id: null | string;
            phone: null | string;
            subscription_groups: {
                channel: string;
                id: string;
                name: string;
                status: "Subscribed" | "Unsubscribed";
            }[];
        }[];
    }

    Properties

    errors? +SubscriptionUserStatusResponse | braze-api

    Interface SubscriptionUserStatusResponse

    interface SubscriptionUserStatusResponse {
        errors?: string[];
        message: string;
        total_count: number;
        users: {
            email: null | string;
            external_id: null | string;
            phone: null | string;
            subscription_groups: {
                channel: string;
                id: string;
                name: string;
                status: "Subscribed" | "Unsubscribed";
            }[];
        }[];
    }

    Properties

    errors? message total_count users -

    Properties

    Optionalerrors

    errors?: string[]

    message

    message: string

    total_count

    total_count: number

    users

    users: {
        email: null | string;
        external_id: null | string;
        phone: null | string;
        subscription_groups: {
            channel: string;
            id: string;
            name: string;
            status: "Subscribed" | "Unsubscribed";
        }[];
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalerrors

    errors?: string[]

    message

    message: string

    total_count

    total_count: number

    users

    users: {
        email: null | string;
        external_id: null | string;
        phone: null | string;
        subscription_groups: {
            channel: string;
            id: string;
            name: string;
            status: "Subscribed" | "Unsubscribed";
        }[];
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/TransactionalV1CampaignsSendObject.html b/interfaces/TransactionalV1CampaignsSendObject.html index 872af5a4..5fde39c4 100644 --- a/interfaces/TransactionalV1CampaignsSendObject.html +++ b/interfaces/TransactionalV1CampaignsSendObject.html @@ -1,6 +1,6 @@ -TransactionalV1CampaignsSendObject | braze-api

    Interface TransactionalV1CampaignsSendObject

    Request body for sending transactional email via API-triggered delivery.

    +TransactionalV1CampaignsSendObject | braze-api

    Interface TransactionalV1CampaignsSendObject

    Request body for sending transactional email via API-triggered delivery.

    https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_transactional_message/#request-body

    -
    interface TransactionalV1CampaignsSendObject {
        external_send_id?: string;
        recipient: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        trigger_properties?: object;
    }

    Properties

    external_send_id? +
    interface TransactionalV1CampaignsSendObject {
        external_send_id?: string;
        recipient: (RecipientWithExternalUserId | RecipientWithUserAlias)[];
        trigger_properties?: object;
    }

    Properties

    external_send_id? recipient trigger_properties? -

    Properties

    Optionalexternal_send_id

    external_send_id?: string

    recipient

    recipient: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalexternal_send_id

    external_send_id?: string

    recipient

    recipient: (RecipientWithExternalUserId | RecipientWithUserAlias)[]

    Optionaltrigger_properties

    trigger_properties?: object

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UpdateContentBlockBody.html b/interfaces/UpdateContentBlockBody.html index da13e590..f27e31d7 100644 --- a/interfaces/UpdateContentBlockBody.html +++ b/interfaces/UpdateContentBlockBody.html @@ -1,9 +1,9 @@ -UpdateContentBlockBody | braze-api

    Interface UpdateContentBlockBody

    Request body for update content block.

    +UpdateContentBlockBody | braze-api

    Interface UpdateContentBlockBody

    Request body for update content block.

    https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_update_content_block/

    -
    interface UpdateContentBlockBody {
        content?: string;
        content_block_id: string;
        description?: string;
        name?: string;
        state?: "active" | "draft";
        tags?: string[];
    }

    Hierarchy

    Properties

    content? +
    interface UpdateContentBlockBody {
        content?: string;
        content_block_id: string;
        description?: string;
        name?: string;
        state?: "active" | "draft";
        tags?: string[];
    }

    Hierarchy

    Properties

    content? content_block_id description? name? state? tags? -

    Properties

    Optionalcontent

    content?: string

    content_block_id

    content_block_id: string

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    Optionalstate

    state?: "active" | "draft"

    Optionaltags

    tags?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcontent

    content?: string

    content_block_id

    content_block_id: string

    Optionaldescription

    description?: string

    Optionalname

    name?: string

    Optionalstate

    state?: "active" | "draft"

    Optionaltags

    tags?: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UpdateEmailTemplateBody.html b/interfaces/UpdateEmailTemplateBody.html index ec1e1ea2..4dd962c9 100644 --- a/interfaces/UpdateEmailTemplateBody.html +++ b/interfaces/UpdateEmailTemplateBody.html @@ -1,6 +1,6 @@ -UpdateEmailTemplateBody | braze-api

    Interface UpdateEmailTemplateBody

    Request body for update email template.

    +UpdateEmailTemplateBody | braze-api

    Interface UpdateEmailTemplateBody

    Request body for update email template.

    https://www.braze.com/docs/api/endpoints/templates/email_templates/post_update_email_template/

    -
    interface UpdateEmailTemplateBody {
        body: string;
        email_template_id: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags?: string[];
        template_name: string;
    }

    Hierarchy (view full)

    Properties

    body +
    interface UpdateEmailTemplateBody {
        body: string;
        email_template_id: string;
        plaintext_body?: string;
        preheader?: string;
        should_inline_css?: boolean;
        subject: string;
        tags?: string[];
        template_name: string;
    }

    Hierarchy (view full)

    Properties

    body email_template_id plaintext_body? preheader? @@ -8,4 +8,4 @@ subject tags? template_name -

    Properties

    body

    body: string

    email_template_id

    email_template_id: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    Optionaltags

    tags?: string[]

    template_name

    template_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: string

    email_template_id

    email_template_id: string

    Optionalplaintext_body

    plaintext_body?: string

    Optionalpreheader

    preheader?: string

    Optionalshould_inline_css

    should_inline_css?: boolean

    subject

    subject: string

    Optionaltags

    tags?: string[]

    template_name

    template_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UserAlias.html b/interfaces/UserAlias.html index 9c9b2092..513cdade 100644 --- a/interfaces/UserAlias.html +++ b/interfaces/UserAlias.html @@ -1,3 +1,3 @@ -UserAlias | braze-api

    Interface UserAlias

    interface UserAlias {
        alias_label: string;
        alias_name: string;
    }

    Properties

    alias_label +UserAlias | braze-api

    Interface UserAlias

    interface UserAlias {
        alias_label: string;
        alias_name: string;
    }

    Properties

    alias_label alias_name -

    Properties

    alias_label

    alias_label: string

    alias_name

    alias_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    alias_label

    alias_label: string

    alias_name

    alias_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UserAliasUpdateObject.html b/interfaces/UserAliasUpdateObject.html index 4a90f19c..a0818661 100644 --- a/interfaces/UserAliasUpdateObject.html +++ b/interfaces/UserAliasUpdateObject.html @@ -1,4 +1,4 @@ -UserAliasUpdateObject | braze-api

    Interface UserAliasUpdateObject

    interface UserAliasUpdateObject {
        alias_label: string;
        new_alias_name: string;
        old_alias_name: string;
    }

    Properties

    alias_label +UserAliasUpdateObject | braze-api

    Interface UserAliasUpdateObject

    interface UserAliasUpdateObject {
        alias_label: string;
        new_alias_name: string;
        old_alias_name: string;
    }

    Properties

    alias_label new_alias_name old_alias_name -

    Properties

    alias_label

    alias_label: string

    new_alias_name

    new_alias_name: string

    old_alias_name

    old_alias_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    alias_label

    alias_label: string

    new_alias_name

    new_alias_name: string

    old_alias_name

    old_alias_name: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UserAliasUpdates.html b/interfaces/UserAliasUpdates.html index b98b68e4..2e04d2a9 100644 --- a/interfaces/UserAliasUpdates.html +++ b/interfaces/UserAliasUpdates.html @@ -1,3 +1,3 @@ -UserAliasUpdates | braze-api

    Interface UserAliasUpdates

    https://www.braze.com/docs/api/endpoints/user_data/post_users_alias_update/#request-body

    -
    interface UserAliasUpdates {
        alias_updates: UserAliasUpdateObject[];
    }

    Properties

    alias_updates -

    Properties

    alias_updates

    alias_updates: UserAliasUpdateObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    +UserAliasUpdates | braze-api

    Interface UserAliasUpdates

    https://www.braze.com/docs/api/endpoints/user_data/post_users_alias_update/#request-body

    +
    interface UserAliasUpdates {
        alias_updates: UserAliasUpdateObject[];
    }

    Properties

    alias_updates +

    Properties

    alias_updates

    alias_updates: UserAliasUpdateObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersAliasObject.html b/interfaces/UsersAliasObject.html index 0b7b3413..6fdbf6b3 100644 --- a/interfaces/UsersAliasObject.html +++ b/interfaces/UsersAliasObject.html @@ -1,3 +1,3 @@ -UsersAliasObject | braze-api

    Interface UsersAliasObject

    https://www.braze.com/docs/api/endpoints/user_data/post_user_alias/#request-body

    -
    interface UsersAliasObject {
        user_aliases: UserAliasObject[];
    }

    Properties

    user_aliases -

    Properties

    user_aliases

    user_aliases: UserAliasObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    +UsersAliasObject | braze-api

    Interface UsersAliasObject

    https://www.braze.com/docs/api/endpoints/user_data/post_user_alias/#request-body

    +
    interface UsersAliasObject {
        user_aliases: UserAliasObject[];
    }

    Properties

    user_aliases +

    Properties

    user_aliases

    user_aliases: UserAliasObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersDeleteObject.html b/interfaces/UsersDeleteObject.html index 928eb21b..bdb8bc25 100644 --- a/interfaces/UsersDeleteObject.html +++ b/interfaces/UsersDeleteObject.html @@ -1,6 +1,6 @@ -UsersDeleteObject | braze-api

    Interface UsersDeleteObject

    Request body for user delete.

    +UsersDeleteObject | braze-api

    Interface UsersDeleteObject

    Request body for user delete.

    https://www.braze.com/docs/api/endpoints/user_data/post_user_delete/#request-body

    -
    interface UsersDeleteObject {
        braze_ids?: string[];
        external_ids?: string[];
        user_aliases?: UserAlias[];
    }

    Properties

    braze_ids? +
    interface UsersDeleteObject {
        braze_ids?: string[];
        external_ids?: string[];
        user_aliases?: UserAlias[];
    }

    Properties

    braze_ids? external_ids? user_aliases? -

    Properties

    Optionalbraze_ids

    braze_ids?: string[]

    Optionalexternal_ids

    external_ids?: string[]

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalbraze_ids

    braze_ids?: string[]

    Optionalexternal_ids

    external_ids?: string[]

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersDeleteResponse.html b/interfaces/UsersDeleteResponse.html index 0db01173..8add8c52 100644 --- a/interfaces/UsersDeleteResponse.html +++ b/interfaces/UsersDeleteResponse.html @@ -1,6 +1,6 @@ -UsersDeleteResponse | braze-api

    Interface UsersDeleteResponse

    Response body for user delete.

    +UsersDeleteResponse | braze-api

    Interface UsersDeleteResponse

    Response body for user delete.

    https://www.braze.com/docs/api/endpoints/user_data/post_user_delete/#request-body

    -
    interface UsersDeleteResponse {
        deleted: number;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • UsersDeleteResponse

    Properties

    deleted +
    interface UsersDeleteResponse {
        deleted: number;
        errors?: string[];
        message: string;
    }

    Hierarchy

    • ServerResponse
      • UsersDeleteResponse

    Properties

    deleted errors? message -

    Properties

    deleted

    deleted: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deleted

    deleted: number

    Optionalerrors

    errors?: string[]

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportGlobalControlGroupObject.html b/interfaces/UsersExportGlobalControlGroupObject.html index 71a11497..88c9ce20 100644 --- a/interfaces/UsersExportGlobalControlGroupObject.html +++ b/interfaces/UsersExportGlobalControlGroupObject.html @@ -1,6 +1,6 @@ -UsersExportGlobalControlGroupObject | braze-api

    Interface UsersExportGlobalControlGroupObject

    Request body for users by Global Control Group.

    +UsersExportGlobalControlGroupObject | braze-api

    Interface UsersExportGlobalControlGroupObject

    Request body for users by Global Control Group.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_global_control_group/#request-body

    -
    interface UsersExportGlobalControlGroupObject {
        callback_endpoint?: string;
        fields_to_export: FieldsToExport[];
        output_format?: "gzip" | "zip";
    }

    Properties

    callback_endpoint? +
    interface UsersExportGlobalControlGroupObject {
        callback_endpoint?: string;
        fields_to_export: FieldsToExport[];
        output_format?: "gzip" | "zip";
    }

    Properties

    callback_endpoint? fields_to_export output_format? -

    Properties

    Optionalcallback_endpoint

    callback_endpoint?: string

    fields_to_export

    fields_to_export: FieldsToExport[]

    Optionaloutput_format

    output_format?: "gzip" | "zip"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcallback_endpoint

    callback_endpoint?: string

    fields_to_export

    fields_to_export: FieldsToExport[]

    Optionaloutput_format

    output_format?: "gzip" | "zip"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportGlobalControlGroupResponse.html b/interfaces/UsersExportGlobalControlGroupResponse.html index 1950a4f8..49c3e840 100644 --- a/interfaces/UsersExportGlobalControlGroupResponse.html +++ b/interfaces/UsersExportGlobalControlGroupResponse.html @@ -1,6 +1,6 @@ -UsersExportGlobalControlGroupResponse | braze-api

    Interface UsersExportGlobalControlGroupResponse

    Response body for users by Global Control Group.

    +UsersExportGlobalControlGroupResponse | braze-api

    Interface UsersExportGlobalControlGroupResponse

    Response body for users by Global Control Group.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_global_control_group/#response

    -
    interface UsersExportGlobalControlGroupResponse {
        message: string;
        object_prefix: string;
        url?: string;
    }

    Properties

    message +
    interface UsersExportGlobalControlGroupResponse {
        message: string;
        object_prefix: string;
        url?: string;
    }

    Properties

    message object_prefix url? -

    Properties

    message

    message: string

    object_prefix

    object_prefix: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    message

    message: string

    object_prefix

    object_prefix: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportIdsObject.html b/interfaces/UsersExportIdsObject.html index 2b39981f..02c40353 100644 --- a/interfaces/UsersExportIdsObject.html +++ b/interfaces/UsersExportIdsObject.html @@ -1,10 +1,10 @@ -UsersExportIdsObject | braze-api

    Interface UsersExportIdsObject

    Request body for users by identifier endpoint.

    +UsersExportIdsObject | braze-api

    Interface UsersExportIdsObject

    Request body for users by identifier endpoint.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier/#request-body

    -
    interface UsersExportIdsObject {
        braze_id?: string;
        device_id?: string;
        email_address?: string;
        external_ids?: string[];
        fields_to_export?: FieldsToExport[];
        phone?: string;
        user_aliases?: UserAlias[];
    }

    Properties

    braze_id? +
    interface UsersExportIdsObject {
        braze_id?: string;
        device_id?: string;
        email_address?: string;
        external_ids?: string[];
        fields_to_export?: FieldsToExport[];
        phone?: string;
        user_aliases?: UserAlias[];
    }

    Properties

    braze_id? device_id? email_address? external_ids? fields_to_export? phone? user_aliases? -

    Properties

    Optionalbraze_id

    braze_id?: string

    Optionaldevice_id

    device_id?: string

    Optionalemail_address

    email_address?: string

    Optionalexternal_ids

    external_ids?: string[]

    Optionalfields_to_export

    fields_to_export?: FieldsToExport[]

    Optionalphone

    phone?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalbraze_id

    braze_id?: string

    Optionaldevice_id

    device_id?: string

    Optionalemail_address

    email_address?: string

    Optionalexternal_ids

    external_ids?: string[]

    Optionalfields_to_export

    fields_to_export?: FieldsToExport[]

    Optionalphone

    phone?: string

    Optionaluser_aliases

    user_aliases?: UserAlias[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportIdsResponse.html b/interfaces/UsersExportIdsResponse.html index 9d873d03..baec27e3 100644 --- a/interfaces/UsersExportIdsResponse.html +++ b/interfaces/UsersExportIdsResponse.html @@ -1,6 +1,6 @@ -UsersExportIdsResponse | braze-api

    Interface UsersExportIdsResponse

    Response body for users by identifier endpoint.

    +UsersExportIdsResponse | braze-api

    Interface UsersExportIdsResponse

    Response body for users by identifier endpoint.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier/#response

    -
    interface UsersExportIdsResponse {
        invalid_user_ids?: string[];
        message: string;
        users: Partial<UserExportObject>[];
    }

    Properties

    invalid_user_ids? +
    interface UsersExportIdsResponse {
        invalid_user_ids?: string[];
        message: string;
        users: Partial<UserExportObject>[];
    }

    Properties

    invalid_user_ids? message users -

    Properties

    Optionalinvalid_user_ids

    invalid_user_ids?: string[]

    message

    message: string

    users

    users: Partial<UserExportObject>[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalinvalid_user_ids

    invalid_user_ids?: string[]

    message

    message: string

    users

    users: Partial<UserExportObject>[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportSegmentObject.html b/interfaces/UsersExportSegmentObject.html index 25b0938a..f745f365 100644 --- a/interfaces/UsersExportSegmentObject.html +++ b/interfaces/UsersExportSegmentObject.html @@ -1,7 +1,7 @@ -UsersExportSegmentObject | braze-api

    Interface UsersExportSegmentObject

    Request body for users by segment endpoint.

    +UsersExportSegmentObject | braze-api

    Interface UsersExportSegmentObject

    Request body for users by segment endpoint.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/#request-body

    -
    interface UsersExportSegmentObject {
        callback_endpoint?: string;
        fields_to_export: FieldsToExport[];
        output_format?: "gzip" | "zip";
        segment_id: string;
    }

    Properties

    callback_endpoint? +
    interface UsersExportSegmentObject {
        callback_endpoint?: string;
        fields_to_export: FieldsToExport[];
        output_format?: "gzip" | "zip";
        segment_id: string;
    }

    Properties

    callback_endpoint? fields_to_export output_format? segment_id -

    Properties

    Optionalcallback_endpoint

    callback_endpoint?: string

    fields_to_export

    fields_to_export: FieldsToExport[]

    Optionaloutput_format

    output_format?: "gzip" | "zip"

    segment_id

    segment_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcallback_endpoint

    callback_endpoint?: string

    fields_to_export

    fields_to_export: FieldsToExport[]

    Optionaloutput_format

    output_format?: "gzip" | "zip"

    segment_id

    segment_id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExportSegmentResponse.html b/interfaces/UsersExportSegmentResponse.html index 14d896fb..e6339bbc 100644 --- a/interfaces/UsersExportSegmentResponse.html +++ b/interfaces/UsersExportSegmentResponse.html @@ -1,6 +1,6 @@ -UsersExportSegmentResponse | braze-api

    Interface UsersExportSegmentResponse

    Response body for users by segment endpoint.

    +UsersExportSegmentResponse | braze-api

    Interface UsersExportSegmentResponse

    Response body for users by segment endpoint.

    https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment/#response

    -
    interface UsersExportSegmentResponse {
        message: string;
        object_prefix: string;
        url?: string;
    }

    Properties

    message +
    interface UsersExportSegmentResponse {
        message: string;
        object_prefix: string;
        url?: string;
    }

    Properties

    message object_prefix url? -

    Properties

    message

    message: string

    object_prefix

    object_prefix: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    message

    message: string

    object_prefix

    object_prefix: string

    Optionalurl

    url?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExternalIdsRemoveObject.html b/interfaces/UsersExternalIdsRemoveObject.html index 718299c1..df8d5590 100644 --- a/interfaces/UsersExternalIdsRemoveObject.html +++ b/interfaces/UsersExternalIdsRemoveObject.html @@ -1,4 +1,4 @@ -UsersExternalIdsRemoveObject | braze-api

    Interface UsersExternalIdsRemoveObject

    Request body for external ID remove.

    +UsersExternalIdsRemoveObject | braze-api

    Interface UsersExternalIdsRemoveObject

    Request body for external ID remove.

    https://www.braze.com/docs/api/endpoints/user_data/external_id_migration/post_external_ids_remove/#request-body

    -
    interface UsersExternalIdsRemoveObject {
        external_ids: string[];
    }

    Properties

    external_ids -

    Properties

    external_ids

    external_ids: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface UsersExternalIdsRemoveObject {
        external_ids: string[];
    }

    Properties

    external_ids +

    Properties

    external_ids

    external_ids: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersExternalIdsRenameObject.html b/interfaces/UsersExternalIdsRenameObject.html index 17763877..3addabdf 100644 --- a/interfaces/UsersExternalIdsRenameObject.html +++ b/interfaces/UsersExternalIdsRenameObject.html @@ -1,4 +1,4 @@ -UsersExternalIdsRenameObject | braze-api

    Interface UsersExternalIdsRenameObject

    Request body for external ID rename.

    +UsersExternalIdsRenameObject | braze-api

    Interface UsersExternalIdsRenameObject

    Request body for external ID rename.

    https://www.braze.com/docs/api/endpoints/user_data/external_id_migration/post_external_ids_rename/#request-body

    -
    interface UsersExternalIdsRenameObject {
        external_id_renames: {
            current_external_id: string;
            new_external_id: string;
        }[];
    }

    Properties

    external_id_renames -

    Properties

    external_id_renames

    external_id_renames: {
        current_external_id: string;
        new_external_id: string;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface UsersExternalIdsRenameObject {
        external_id_renames: {
            current_external_id: string;
            new_external_id: string;
        }[];
    }

    Properties

    external_id_renames +

    Properties

    external_id_renames

    external_id_renames: {
        current_external_id: string;
        new_external_id: string;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersIdentifyObject.html b/interfaces/UsersIdentifyObject.html index 1ebb557f..ef5ab163 100644 --- a/interfaces/UsersIdentifyObject.html +++ b/interfaces/UsersIdentifyObject.html @@ -1,4 +1,4 @@ -UsersIdentifyObject | braze-api

    Interface UsersIdentifyObject

    Request body for user identify.

    +UsersIdentifyObject | braze-api

    Interface UsersIdentifyObject

    Request body for user identify.

    https://www.braze.com/docs/api/endpoints/user_data/post_user_identify/#request-body

    -
    interface UsersIdentifyObject {
        aliases_to_identify: {
            external_id: string;
            user_alias: UserAlias;
        }[];
    }

    Properties

    aliases_to_identify -

    Properties

    aliases_to_identify

    aliases_to_identify: {
        external_id: string;
        user_alias: UserAlias;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface UsersIdentifyObject {
        aliases_to_identify: {
            external_id: string;
            user_alias: UserAlias;
        }[];
    }

    Properties

    aliases_to_identify +

    Properties

    aliases_to_identify

    aliases_to_identify: {
        external_id: string;
        user_alias: UserAlias;
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersMergeObject.html b/interfaces/UsersMergeObject.html index ad0dd4ae..1ed1b036 100644 --- a/interfaces/UsersMergeObject.html +++ b/interfaces/UsersMergeObject.html @@ -1,4 +1,4 @@ -UsersMergeObject | braze-api

    Interface UsersMergeObject

    Request body for user merge.

    +UsersMergeObject | braze-api

    Interface UsersMergeObject

    Request body for user merge.

    https://www.braze.com/docs/api/endpoints/user_data/post_users_merge/#request-body

    -
    interface UsersMergeObject {
        merge_updates: {
            identifier_to_keep: {
                external_id: string;
            } | {
                user_alias: UserAlias;
            };
            identifier_to_merge: {
                external_id: string;
            } | {
                user_alias: UserAlias;
            };
        }[];
    }

    Properties

    merge_updates -

    Properties

    merge_updates

    merge_updates: {
        identifier_to_keep: {
            external_id: string;
        } | {
            user_alias: UserAlias;
        };
        identifier_to_merge: {
            external_id: string;
        } | {
            user_alias: UserAlias;
        };
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface UsersMergeObject {
        merge_updates: {
            identifier_to_keep: {
                external_id: string;
            } | {
                user_alias: UserAlias;
            };
            identifier_to_merge: {
                external_id: string;
            } | {
                user_alias: UserAlias;
            };
        }[];
    }

    Properties

    merge_updates +

    Properties

    merge_updates

    merge_updates: {
        identifier_to_keep: {
            external_id: string;
        } | {
            user_alias: UserAlias;
        };
        identifier_to_merge: {
            external_id: string;
        } | {
            user_alias: UserAlias;
        };
    }[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/UsersTrackObject.html b/interfaces/UsersTrackObject.html index 2aaf4418..5a4cb02a 100644 --- a/interfaces/UsersTrackObject.html +++ b/interfaces/UsersTrackObject.html @@ -1,6 +1,6 @@ -UsersTrackObject | braze-api

    Interface UsersTrackObject

    Request body for user track.

    +UsersTrackObject | braze-api

    Interface UsersTrackObject

    Request body for user track.

    https://www.braze.com/docs/api/endpoints/user_data/post_user_track/#request-body

    -
    interface UsersTrackObject {
        attributes?: UserAttributesObject[];
        events?: EventObject[];
        purchases?: PurchaseObject[];
    }

    Properties

    attributes? +
    interface UsersTrackObject {
        attributes?: UserAttributesObject[];
        events?: EventObject[];
        purchases?: PurchaseObject[];
    }

    Properties

    attributes? events? purchases? -

    Properties

    Optionalattributes

    attributes?: UserAttributesObject[]

    Optionalevents

    events?: EventObject[]

    Optionalpurchases

    purchases?: PurchaseObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalattributes

    attributes?: UserAttributesObject[]

    Optionalevents

    events?: EventObject[]

    Optionalpurchases

    purchases?: PurchaseObject[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/V2SubscriptionStatusSetObject.html b/interfaces/V2SubscriptionStatusSetObject.html index dc6afa19..88134ad7 100644 --- a/interfaces/V2SubscriptionStatusSetObject.html +++ b/interfaces/V2SubscriptionStatusSetObject.html @@ -1,4 +1,4 @@ -V2SubscriptionStatusSetObject | braze-api

    Interface V2SubscriptionStatusSetObject

    Request body for update user’s subscription group status.

    +V2SubscriptionStatusSetObject | braze-api

    Interface V2SubscriptionStatusSetObject

    Request body for update user’s subscription group status.

    https://www.braze.com/docs/api/endpoints/subscription_groups/post_update_user_subscription_group_status_v2/#request-body

    -
    interface V2SubscriptionStatusSetObject {
        subscription_groups: SubscriptionGroupWithExternalIds[] | SubscriptionGroupWithPhones[] | SubscriptionGroupWithEmails[];
    }

    Properties

    subscription_groups -

    Properties

    subscription_groups

    subscription_groups: SubscriptionGroupWithExternalIds[] | SubscriptionGroupWithPhones[] | SubscriptionGroupWithEmails[]

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface V2SubscriptionStatusSetObject {
        subscription_groups: SubscriptionGroupWithExternalIds[] | SubscriptionGroupWithPhones[] | SubscriptionGroupWithEmails[];
    }

    Properties

    subscription_groups +

    Properties

    subscription_groups

    subscription_groups: SubscriptionGroupWithExternalIds[] | SubscriptionGroupWithPhones[] | SubscriptionGroupWithEmails[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules.html b/modules.html index 1fd1c7d5..cf9d3e63 100644 --- a/modules.html +++ b/modules.html @@ -1,4 +1,4 @@ -braze-api

    braze-api

    Index

    Classes

    Braze +braze-api

    braze-api

    Index

    Classes

    Braze

    Interfaces

    AndroidConversationPushMessageObject AndroidConversationPushObject AndroidConversationPushPersonObject diff --git a/types/Attributes.html b/types/Attributes.html index 0ce33e2c..53b750f7 100644 --- a/types/Attributes.html +++ b/types/Attributes.html @@ -1 +1 @@ -Attributes | braze-api

    Type Alias Attributes

    Attributes: object

    Settings

    Member Visibility
    +Attributes | braze-api

    Type Alias Attributes

    Attributes: object

    Settings

    Member Visibility
    diff --git a/types/CatalogListItem.html b/types/CatalogListItem.html index 4e508efe..9e05f168 100644 --- a/types/CatalogListItem.html +++ b/types/CatalogListItem.html @@ -1 +1 @@ -CatalogListItem | braze-api

    Type Alias CatalogListItem<T>

    CatalogListItem<T>: {
        id: string;
    } & T

    Type Parameters

    • T extends RequestBody = Record<string, unknown>

    Settings

    Member Visibility
    +CatalogListItem | braze-api

    Type Alias CatalogListItem<T>

    CatalogListItem<T>: {
        id: string;
    } & T

    Type Parameters

    • T extends RequestBody = Record<string, unknown>

    Settings

    Member Visibility
    diff --git a/types/Properties.html b/types/Properties.html index 97b961a2..0ad28985 100644 --- a/types/Properties.html +++ b/types/Properties.html @@ -1 +1 @@ -Properties | braze-api

    Type Alias Properties

    Properties: object

    Settings

    Member Visibility
    +Properties | braze-api

    Type Alias Properties

    Properties: object

    Settings

    Member Visibility
    diff --git a/types/SubscriptionStatusSetObject.html b/types/SubscriptionStatusSetObject.html index 87ddd25f..654038ea 100644 --- a/types/SubscriptionStatusSetObject.html +++ b/types/SubscriptionStatusSetObject.html @@ -1,3 +1,3 @@ -SubscriptionStatusSetObject | braze-api

    Type Alias SubscriptionStatusSetObject

    SubscriptionStatusSetObject: SubscriptionStatusSetWithPhone | SubscriptionStatusSetWithEmail

    Request body for update user’s subscription group status.

    +SubscriptionStatusSetObject | braze-api

    Type Alias SubscriptionStatusSetObject

    SubscriptionStatusSetObject: SubscriptionStatusSetWithPhone | SubscriptionStatusSetWithEmail

    Request body for update user’s subscription group status.

    https://www.braze.com/docs/api/endpoints/subscription_groups/post_update_user_subscription_group_status/#request-body

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/TriggerProperties.html b/types/TriggerProperties.html index cd84010d..f8486f80 100644 --- a/types/TriggerProperties.html +++ b/types/TriggerProperties.html @@ -1 +1 @@ -TriggerProperties | braze-api

    Type Alias TriggerProperties

    TriggerProperties: object

    Settings

    Member Visibility
    +TriggerProperties | braze-api

    Type Alias TriggerProperties

    TriggerProperties: object

    Settings

    Member Visibility