/** * @example * { * customContactFilter: {} * } */ export interface RequestContactExportRequest { /** Set the filter for the contacts to be exported. */ customContactFilter: RequestContactExportRequest.CustomContactFilter; /** To avoid generating the email notification upon contact export, pass **true** */ disableNotification?: boolean; /** List of all the attributes that you want to export. **These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. ** For example: **['fname', 'lname', 'email']** */ exportAttributes?: string[]; /** To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME */ exportMandatoryAttributes?: boolean; /** Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME. */ exportMetadata?: string[]; /** Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format. */ exportDateInUTC?: boolean; /** Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact. */ exportSubscriptionStatus?: string[]; /** Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 */ notifyUrl?: string; } export declare namespace RequestContactExportRequest { /** * Set the filter for the contacts to be exported. */ interface CustomContactFilter { /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */ actionForContacts?: CustomContactFilter.ActionForContacts | undefined; /** **Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). */ actionForEmailCampaigns?: CustomContactFilter.ActionForEmailCampaigns | undefined; /** **Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. */ actionForSmsCampaigns?: CustomContactFilter.ActionForSmsCampaigns | undefined; /** Considered only if **actionForEmailCampaigns** is passed, ignored otherwise. **Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed.** The id of the email campaign for which the corresponding action shall be applied in the filter. */ emailCampaignId?: number | undefined; /** ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included. */ listId?: number | undefined; /** ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. */ segmentId?: number | undefined; /** Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. */ smsCampaignId?: number | undefined; } namespace CustomContactFilter { /** **Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on contacts as per the list id. * **allContacts** - Fetch the list of all contacts for a particular list. * **subscribed & unsubscribed** - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * **unsubscribedPerList** - Fetch the list of contacts that are unsubscribed from a particular list only. */ const ActionForContacts: { readonly AllContacts: "allContacts"; readonly Subscribed: "subscribed"; readonly Unsubscribed: "unsubscribed"; readonly UnsubscribedPerList: "unsubscribedPerList"; }; type ActionForContacts = (typeof ActionForContacts)[keyof typeof ActionForContacts]; /** **Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.** This will export the contacts on the basis of provided action applied on email campaigns. * **openers & nonOpeners** - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * **clickers & nonClickers** - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * **unsubscribed** - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * **hardBounces & softBounces** - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). */ const ActionForEmailCampaigns: { readonly Openers: "openers"; readonly NonOpeners: "nonOpeners"; readonly Clickers: "clickers"; readonly NonClickers: "nonClickers"; readonly Unsubscribed: "unsubscribed"; readonly HardBounces: "hardBounces"; readonly SoftBounces: "softBounces"; }; type ActionForEmailCampaigns = (typeof ActionForEmailCampaigns)[keyof typeof ActionForEmailCampaigns]; /** **Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.** This will export the contacts on the basis of provided action applied on sms campaigns. * **unsubscribed** - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * **hardBounces & softBounces** - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. */ const ActionForSmsCampaigns: { readonly HardBounces: "hardBounces"; readonly SoftBounces: "softBounces"; readonly Unsubscribed: "unsubscribed"; }; type ActionForSmsCampaigns = (typeof ActionForSmsCampaigns)[keyof typeof ActionForSmsCampaigns]; } }