@getbrevo/brevo 6.0.1 → 6.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.d.ts +10 -0
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +68 -58
- package/dist/cjs/api/errors/BadRequestError.js +1 -1
- package/dist/cjs/api/errors/ConflictError.js +1 -1
- package/dist/cjs/api/errors/ExpectationFailedError.js +1 -1
- package/dist/cjs/api/errors/FailedDependencyError.js +1 -1
- package/dist/cjs/api/errors/ForbiddenError.js +1 -1
- package/dist/cjs/api/errors/InternalServerError.js +1 -1
- package/dist/cjs/api/errors/MethodNotAllowedError.js +1 -1
- package/dist/cjs/api/errors/NotFoundError.js +1 -1
- package/dist/cjs/api/errors/PaymentRequiredError.js +1 -1
- package/dist/cjs/api/errors/PreconditionFailedError.js +1 -1
- package/dist/cjs/api/errors/TooEarlyError.js +1 -1
- package/dist/cjs/api/errors/TooManyRequestsError.js +1 -1
- package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
- package/dist/cjs/api/errors/UnprocessableEntityError.js +1 -1
- package/dist/cjs/api/errors/UnsupportedMediaTypeError.js +1 -1
- package/dist/cjs/api/resources/balance/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/consentGroups/client/Client.d.ts +108 -0
- package/dist/cjs/api/resources/consentGroups/client/Client.js +383 -0
- package/dist/cjs/api/resources/consentGroups/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/consentGroups/client/index.js +17 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.ts +25 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.js +12 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.ts +10 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.js +3 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.ts +10 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupRequest.js +3 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.ts +17 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.js +3 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.ts +24 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.js +12 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/consentGroups/client/requests/index.js +7 -0
- package/dist/cjs/api/resources/consentGroups/exports.d.ts +2 -0
- package/dist/cjs/api/resources/consentGroups/exports.js +21 -0
- package/dist/cjs/api/resources/consentGroups/index.d.ts +2 -0
- package/dist/cjs/api/resources/consentGroups/index.js +18 -0
- package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.ts +5 -0
- package/dist/cjs/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.js +8 -0
- package/dist/cjs/api/resources/consentGroups/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/consentGroups/types/index.js +17 -0
- package/dist/cjs/api/resources/contacts/client/requests/ImportContactsRequest.d.ts +2 -0
- package/dist/cjs/api/resources/contacts/types/GetContactInfoResponse.d.ts +4 -1
- package/dist/cjs/api/resources/contacts/types/GetContactStatsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/deals/client/Client.js +4 -1
- package/dist/cjs/api/resources/deals/client/requests/GetCrmDealsRequest.d.ts +6 -0
- package/dist/cjs/api/resources/ecommerce/types/CreateBatchOrderResponse.d.ts +2 -2
- package/dist/cjs/api/resources/index.d.ts +5 -0
- package/dist/cjs/api/resources/index.js +6 -1
- package/dist/cjs/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.ts +1 -1
- package/dist/cjs/api/resources/wallet/client/Client.d.ts +34 -0
- package/dist/cjs/api/resources/wallet/client/Client.js +126 -0
- package/dist/cjs/api/resources/wallet/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/client/index.js +17 -0
- package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.ts +13 -0
- package/dist/cjs/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.js +3 -0
- package/dist/cjs/api/resources/wallet/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/wallet/exports.d.ts +2 -0
- package/dist/cjs/api/resources/wallet/exports.js +21 -0
- package/dist/cjs/api/resources/wallet/index.d.ts +1 -0
- package/dist/cjs/api/resources/wallet/index.js +17 -0
- package/dist/cjs/api/types/ConsentGroup.d.ts +29 -0
- package/dist/cjs/api/types/ConsentGroup.js +12 -0
- package/dist/cjs/api/types/ConsentGroupItem.d.ts +17 -0
- package/dist/cjs/api/types/ConsentGroupItem.js +12 -0
- package/dist/cjs/api/types/ConsentGroupsListResponse.d.ts +14 -0
- package/dist/cjs/api/types/ConsentGroupsListResponse.js +3 -0
- package/dist/cjs/api/types/GetCampaignStats.d.ts +11 -11
- package/dist/cjs/api/types/GetContactDetails.d.ts +3 -0
- package/dist/cjs/api/types/WalletPassInstallUrl.d.ts +4 -0
- package/dist/cjs/api/types/WalletPassInstallUrl.js +3 -0
- package/dist/cjs/api/types/index.d.ts +4 -0
- package/dist/cjs/api/types/index.js +4 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +11 -0
- package/dist/cjs/core/fetcher/signals.js +9 -1
- package/dist/cjs/core/url/qs.js +2 -2
- package/dist/cjs/errors/BrevoError.d.ts +1 -0
- package/dist/cjs/errors/BrevoError.js +5 -1
- package/dist/cjs/errors/BrevoTimeoutError.d.ts +2 -2
- package/dist/cjs/errors/BrevoTimeoutError.js +40 -6
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +10 -0
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/errors/BadRequestError.mjs +1 -1
- package/dist/esm/api/errors/ConflictError.mjs +1 -1
- package/dist/esm/api/errors/ExpectationFailedError.mjs +1 -1
- package/dist/esm/api/errors/FailedDependencyError.mjs +1 -1
- package/dist/esm/api/errors/ForbiddenError.mjs +1 -1
- package/dist/esm/api/errors/InternalServerError.mjs +1 -1
- package/dist/esm/api/errors/MethodNotAllowedError.mjs +1 -1
- package/dist/esm/api/errors/NotFoundError.mjs +1 -1
- package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -1
- package/dist/esm/api/errors/PreconditionFailedError.mjs +1 -1
- package/dist/esm/api/errors/TooEarlyError.mjs +1 -1
- package/dist/esm/api/errors/TooManyRequestsError.mjs +1 -1
- package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +1 -1
- package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +1 -1
- package/dist/esm/api/resources/balance/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/consentGroups/client/Client.d.mts +108 -0
- package/dist/esm/api/resources/consentGroups/client/Client.mjs +346 -0
- package/dist/esm/api/resources/consentGroups/client/index.d.mts +1 -0
- package/dist/esm/api/resources/consentGroups/client/index.mjs +1 -0
- package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.d.mts +25 -0
- package/dist/esm/api/resources/consentGroups/client/requests/CreateConsentGroupRequest.mjs +9 -0
- package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.d.mts +10 -0
- package/dist/esm/api/resources/consentGroups/client/requests/DeleteConsentGroupRequest.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.d.mts +10 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupRequest.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.d.mts +17 -0
- package/dist/esm/api/resources/consentGroups/client/requests/GetConsentGroupsRequest.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.d.mts +24 -0
- package/dist/esm/api/resources/consentGroups/client/requests/UpdateConsentGroupRequest.mjs +9 -0
- package/dist/esm/api/resources/consentGroups/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/consentGroups/client/requests/index.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/exports.d.mts +2 -0
- package/dist/esm/api/resources/consentGroups/exports.mjs +3 -0
- package/dist/esm/api/resources/consentGroups/index.d.mts +2 -0
- package/dist/esm/api/resources/consentGroups/index.mjs +2 -0
- package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.d.mts +5 -0
- package/dist/esm/api/resources/consentGroups/types/GetConsentGroupsRequestSignupMode.mjs +5 -0
- package/dist/esm/api/resources/consentGroups/types/index.d.mts +1 -0
- package/dist/esm/api/resources/consentGroups/types/index.mjs +1 -0
- package/dist/esm/api/resources/contacts/client/requests/ImportContactsRequest.d.mts +2 -0
- package/dist/esm/api/resources/contacts/types/GetContactInfoResponse.d.mts +4 -1
- package/dist/esm/api/resources/contacts/types/GetContactStatsResponse.d.mts +1 -1
- package/dist/esm/api/resources/deals/client/Client.mjs +4 -1
- package/dist/esm/api/resources/deals/client/requests/GetCrmDealsRequest.d.mts +6 -0
- package/dist/esm/api/resources/ecommerce/types/CreateBatchOrderResponse.d.mts +2 -2
- package/dist/esm/api/resources/index.d.mts +5 -0
- package/dist/esm/api/resources/index.mjs +5 -0
- package/dist/esm/api/resources/transactionalEmails/types/GetTransacBlockedContactsResponse.d.mts +1 -1
- package/dist/esm/api/resources/wallet/client/Client.d.mts +34 -0
- package/dist/esm/api/resources/wallet/client/Client.mjs +89 -0
- package/dist/esm/api/resources/wallet/client/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/client/index.mjs +1 -0
- package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.d.mts +13 -0
- package/dist/esm/api/resources/wallet/client/requests/GetWalletPassInstallUrlRequest.mjs +2 -0
- package/dist/esm/api/resources/wallet/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/wallet/exports.d.mts +2 -0
- package/dist/esm/api/resources/wallet/exports.mjs +3 -0
- package/dist/esm/api/resources/wallet/index.d.mts +1 -0
- package/dist/esm/api/resources/wallet/index.mjs +1 -0
- package/dist/esm/api/types/ConsentGroup.d.mts +29 -0
- package/dist/esm/api/types/ConsentGroup.mjs +9 -0
- package/dist/esm/api/types/ConsentGroupItem.d.mts +17 -0
- package/dist/esm/api/types/ConsentGroupItem.mjs +9 -0
- package/dist/esm/api/types/ConsentGroupsListResponse.d.mts +14 -0
- package/dist/esm/api/types/ConsentGroupsListResponse.mjs +2 -0
- package/dist/esm/api/types/GetCampaignStats.d.mts +11 -11
- package/dist/esm/api/types/GetContactDetails.d.mts +3 -0
- package/dist/esm/api/types/WalletPassInstallUrl.d.mts +4 -0
- package/dist/esm/api/types/WalletPassInstallUrl.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +4 -0
- package/dist/esm/api/types/index.mjs +4 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +11 -0
- package/dist/esm/core/fetcher/signals.mjs +9 -1
- package/dist/esm/core/url/qs.mjs +2 -2
- package/dist/esm/errors/BrevoError.d.mts +1 -0
- package/dist/esm/errors/BrevoError.mjs +5 -1
- package/dist/esm/errors/BrevoTimeoutError.d.mts +2 -2
- package/dist/esm/errors/BrevoTimeoutError.mjs +7 -6
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +23 -1
- package/reference.md +403 -1
package/dist/cjs/BaseClient.d.ts
CHANGED
|
@@ -16,6 +16,11 @@ export type BaseClientOptions = {
|
|
|
16
16
|
fetch?: typeof fetch;
|
|
17
17
|
/** Configure logging for the client. */
|
|
18
18
|
logging?: core.logging.LogConfig | core.logging.Logger;
|
|
19
|
+
/** Default options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
|
|
20
|
+
stream?: {
|
|
21
|
+
reconnectionEnabled?: boolean;
|
|
22
|
+
maxReconnectionAttempts?: number;
|
|
23
|
+
};
|
|
19
24
|
/** Override auth. Pass false to disable, a function returning auth headers, an AuthProvider, or auth options. */
|
|
20
25
|
auth?: AuthOption;
|
|
21
26
|
} & HeaderAuthProvider.AuthOptions;
|
|
@@ -30,6 +35,11 @@ export interface BaseRequestOptions {
|
|
|
30
35
|
queryParams?: Record<string, unknown>;
|
|
31
36
|
/** Additional headers to include in the request. */
|
|
32
37
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
38
|
+
/** Options for SSE stream reconnection behavior. Has no effect on non-resumable endpoints. */
|
|
39
|
+
stream?: {
|
|
40
|
+
reconnectionEnabled?: boolean;
|
|
41
|
+
maxReconnectionAttempts?: number;
|
|
42
|
+
};
|
|
33
43
|
}
|
|
34
44
|
export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
|
|
35
45
|
logging: core.logging.Logger;
|
package/dist/cjs/BaseClient.js
CHANGED
|
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
|
|
|
43
43
|
const headers = (0, headers_js_1.mergeHeaders)({
|
|
44
44
|
"X-Fern-Language": "JavaScript",
|
|
45
45
|
"X-Fern-SDK-Name": "@getbrevo/brevo",
|
|
46
|
-
"X-Fern-SDK-Version": "6.0.
|
|
47
|
-
"User-Agent": "@getbrevo/brevo/6.0.
|
|
46
|
+
"X-Fern-SDK-Version": "6.0.2",
|
|
47
|
+
"User-Agent": "@getbrevo/brevo/6.0.2",
|
|
48
48
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
49
49
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
50
50
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AccountClient } from "./api/resources/account/client/Client.js";
|
|
2
2
|
import { BalanceClient } from "./api/resources/balance/client/Client.js";
|
|
3
3
|
import { CompaniesClient } from "./api/resources/companies/client/Client.js";
|
|
4
|
+
import { ConsentGroupsClient } from "./api/resources/consentGroups/client/Client.js";
|
|
4
5
|
import { ContactsClient } from "./api/resources/contacts/client/Client.js";
|
|
5
6
|
import { ConversationsClient } from "./api/resources/conversations/client/Client.js";
|
|
6
7
|
import { CouponsClient } from "./api/resources/coupons/client/Client.js";
|
|
@@ -28,6 +29,7 @@ import { TransactionalEmailsClient } from "./api/resources/transactionalEmails/c
|
|
|
28
29
|
import { TransactionalSmsClient } from "./api/resources/transactionalSms/client/Client.js";
|
|
29
30
|
import { TransactionalWhatsAppClient } from "./api/resources/transactionalWhatsApp/client/Client.js";
|
|
30
31
|
import { UserClient } from "./api/resources/user/client/Client.js";
|
|
32
|
+
import { WalletClient } from "./api/resources/wallet/client/Client.js";
|
|
31
33
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client.js";
|
|
32
34
|
import { WhatsAppCampaignsClient } from "./api/resources/whatsAppCampaigns/client/Client.js";
|
|
33
35
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
@@ -50,6 +52,7 @@ export declare class BrevoClient {
|
|
|
50
52
|
protected _externalFeeds: ExternalFeedsClient | undefined;
|
|
51
53
|
protected _customObjects: CustomObjectsClient | undefined;
|
|
52
54
|
protected _contacts: ContactsClient | undefined;
|
|
55
|
+
protected _consentGroups: ConsentGroupsClient | undefined;
|
|
53
56
|
protected _conversations: ConversationsClient | undefined;
|
|
54
57
|
protected _ecommerce: EcommerceClient | undefined;
|
|
55
58
|
protected _coupons: CouponsClient | undefined;
|
|
@@ -60,6 +63,7 @@ export declare class BrevoClient {
|
|
|
60
63
|
protected _program: ProgramClient | undefined;
|
|
61
64
|
protected _reward: RewardClient | undefined;
|
|
62
65
|
protected _tier: TierClient | undefined;
|
|
66
|
+
protected _wallet: WalletClient | undefined;
|
|
63
67
|
protected _emailCampaigns: EmailCampaignsClient | undefined;
|
|
64
68
|
protected _smsCampaigns: SmsCampaignsClient | undefined;
|
|
65
69
|
protected _whatsAppCampaigns: WhatsAppCampaignsClient | undefined;
|
|
@@ -83,6 +87,7 @@ export declare class BrevoClient {
|
|
|
83
87
|
get externalFeeds(): ExternalFeedsClient;
|
|
84
88
|
get customObjects(): CustomObjectsClient;
|
|
85
89
|
get contacts(): ContactsClient;
|
|
90
|
+
get consentGroups(): ConsentGroupsClient;
|
|
86
91
|
get conversations(): ConversationsClient;
|
|
87
92
|
get ecommerce(): EcommerceClient;
|
|
88
93
|
get coupons(): CouponsClient;
|
|
@@ -93,6 +98,7 @@ export declare class BrevoClient {
|
|
|
93
98
|
get program(): ProgramClient;
|
|
94
99
|
get reward(): RewardClient;
|
|
95
100
|
get tier(): TierClient;
|
|
101
|
+
get wallet(): WalletClient;
|
|
96
102
|
get emailCampaigns(): EmailCampaignsClient;
|
|
97
103
|
get smsCampaigns(): SmsCampaignsClient;
|
|
98
104
|
get whatsAppCampaigns(): WhatsAppCampaignsClient;
|
package/dist/cjs/Client.js
CHANGED
|
@@ -47,35 +47,37 @@ exports.BrevoClient = void 0;
|
|
|
47
47
|
const Client_js_1 = require("./api/resources/account/client/Client.js");
|
|
48
48
|
const Client_js_2 = require("./api/resources/balance/client/Client.js");
|
|
49
49
|
const Client_js_3 = require("./api/resources/companies/client/Client.js");
|
|
50
|
-
const Client_js_4 = require("./api/resources/
|
|
51
|
-
const Client_js_5 = require("./api/resources/
|
|
52
|
-
const Client_js_6 = require("./api/resources/
|
|
53
|
-
const Client_js_7 = require("./api/resources/
|
|
54
|
-
const Client_js_8 = require("./api/resources/
|
|
55
|
-
const Client_js_9 = require("./api/resources/
|
|
56
|
-
const Client_js_10 = require("./api/resources/
|
|
57
|
-
const Client_js_11 = require("./api/resources/
|
|
58
|
-
const Client_js_12 = require("./api/resources/
|
|
59
|
-
const Client_js_13 = require("./api/resources/
|
|
60
|
-
const Client_js_14 = require("./api/resources/
|
|
61
|
-
const Client_js_15 = require("./api/resources/
|
|
62
|
-
const Client_js_16 = require("./api/resources/
|
|
63
|
-
const Client_js_17 = require("./api/resources/
|
|
64
|
-
const Client_js_18 = require("./api/resources/
|
|
65
|
-
const Client_js_19 = require("./api/resources/
|
|
66
|
-
const Client_js_20 = require("./api/resources/
|
|
67
|
-
const Client_js_21 = require("./api/resources/
|
|
68
|
-
const Client_js_22 = require("./api/resources/
|
|
69
|
-
const Client_js_23 = require("./api/resources/
|
|
70
|
-
const Client_js_24 = require("./api/resources/
|
|
71
|
-
const Client_js_25 = require("./api/resources/
|
|
72
|
-
const Client_js_26 = require("./api/resources/
|
|
73
|
-
const Client_js_27 = require("./api/resources/
|
|
74
|
-
const Client_js_28 = require("./api/resources/
|
|
75
|
-
const Client_js_29 = require("./api/resources/
|
|
76
|
-
const Client_js_30 = require("./api/resources/
|
|
77
|
-
const Client_js_31 = require("./api/resources/
|
|
78
|
-
const Client_js_32 = require("./api/resources/
|
|
50
|
+
const Client_js_4 = require("./api/resources/consentGroups/client/Client.js");
|
|
51
|
+
const Client_js_5 = require("./api/resources/contacts/client/Client.js");
|
|
52
|
+
const Client_js_6 = require("./api/resources/conversations/client/Client.js");
|
|
53
|
+
const Client_js_7 = require("./api/resources/coupons/client/Client.js");
|
|
54
|
+
const Client_js_8 = require("./api/resources/customObjects/client/Client.js");
|
|
55
|
+
const Client_js_9 = require("./api/resources/deals/client/Client.js");
|
|
56
|
+
const Client_js_10 = require("./api/resources/domains/client/Client.js");
|
|
57
|
+
const Client_js_11 = require("./api/resources/ecommerce/client/Client.js");
|
|
58
|
+
const Client_js_12 = require("./api/resources/emailCampaigns/client/Client.js");
|
|
59
|
+
const Client_js_13 = require("./api/resources/event/client/Client.js");
|
|
60
|
+
const Client_js_14 = require("./api/resources/externalFeeds/client/Client.js");
|
|
61
|
+
const Client_js_15 = require("./api/resources/files/client/Client.js");
|
|
62
|
+
const Client_js_16 = require("./api/resources/inboundParsing/client/Client.js");
|
|
63
|
+
const Client_js_17 = require("./api/resources/masterAccount/client/Client.js");
|
|
64
|
+
const Client_js_18 = require("./api/resources/notes/client/Client.js");
|
|
65
|
+
const Client_js_19 = require("./api/resources/payments/client/Client.js");
|
|
66
|
+
const Client_js_20 = require("./api/resources/process/client/Client.js");
|
|
67
|
+
const Client_js_21 = require("./api/resources/program/client/Client.js");
|
|
68
|
+
const Client_js_22 = require("./api/resources/reward/client/Client.js");
|
|
69
|
+
const Client_js_23 = require("./api/resources/senders/client/Client.js");
|
|
70
|
+
const Client_js_24 = require("./api/resources/smsCampaigns/client/Client.js");
|
|
71
|
+
const Client_js_25 = require("./api/resources/smsTemplates/client/Client.js");
|
|
72
|
+
const Client_js_26 = require("./api/resources/tasks/client/Client.js");
|
|
73
|
+
const Client_js_27 = require("./api/resources/tier/client/Client.js");
|
|
74
|
+
const Client_js_28 = require("./api/resources/transactionalEmails/client/Client.js");
|
|
75
|
+
const Client_js_29 = require("./api/resources/transactionalSms/client/Client.js");
|
|
76
|
+
const Client_js_30 = require("./api/resources/transactionalWhatsApp/client/Client.js");
|
|
77
|
+
const Client_js_31 = require("./api/resources/user/client/Client.js");
|
|
78
|
+
const Client_js_32 = require("./api/resources/wallet/client/Client.js");
|
|
79
|
+
const Client_js_33 = require("./api/resources/webhooks/client/Client.js");
|
|
80
|
+
const Client_js_34 = require("./api/resources/whatsAppCampaigns/client/Client.js");
|
|
79
81
|
const BaseClient_js_1 = require("./BaseClient.js");
|
|
80
82
|
const core = __importStar(require("./core/index.js"));
|
|
81
83
|
class BrevoClient {
|
|
@@ -88,63 +90,67 @@ class BrevoClient {
|
|
|
88
90
|
}
|
|
89
91
|
get masterAccount() {
|
|
90
92
|
var _a;
|
|
91
|
-
return ((_a = this._masterAccount) !== null && _a !== void 0 ? _a : (this._masterAccount = new
|
|
93
|
+
return ((_a = this._masterAccount) !== null && _a !== void 0 ? _a : (this._masterAccount = new Client_js_17.MasterAccountClient(this._options)));
|
|
92
94
|
}
|
|
93
95
|
get user() {
|
|
94
96
|
var _a;
|
|
95
|
-
return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new
|
|
97
|
+
return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_js_31.UserClient(this._options)));
|
|
96
98
|
}
|
|
97
99
|
get process() {
|
|
98
100
|
var _a;
|
|
99
|
-
return ((_a = this._process) !== null && _a !== void 0 ? _a : (this._process = new
|
|
101
|
+
return ((_a = this._process) !== null && _a !== void 0 ? _a : (this._process = new Client_js_20.ProcessClient(this._options)));
|
|
100
102
|
}
|
|
101
103
|
get senders() {
|
|
102
104
|
var _a;
|
|
103
|
-
return ((_a = this._senders) !== null && _a !== void 0 ? _a : (this._senders = new
|
|
105
|
+
return ((_a = this._senders) !== null && _a !== void 0 ? _a : (this._senders = new Client_js_23.SendersClient(this._options)));
|
|
104
106
|
}
|
|
105
107
|
get domains() {
|
|
106
108
|
var _a;
|
|
107
|
-
return ((_a = this._domains) !== null && _a !== void 0 ? _a : (this._domains = new
|
|
109
|
+
return ((_a = this._domains) !== null && _a !== void 0 ? _a : (this._domains = new Client_js_10.DomainsClient(this._options)));
|
|
108
110
|
}
|
|
109
111
|
get webhooks() {
|
|
110
112
|
var _a;
|
|
111
|
-
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new
|
|
113
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_33.WebhooksClient(this._options)));
|
|
112
114
|
}
|
|
113
115
|
get externalFeeds() {
|
|
114
116
|
var _a;
|
|
115
|
-
return ((_a = this._externalFeeds) !== null && _a !== void 0 ? _a : (this._externalFeeds = new
|
|
117
|
+
return ((_a = this._externalFeeds) !== null && _a !== void 0 ? _a : (this._externalFeeds = new Client_js_14.ExternalFeedsClient(this._options)));
|
|
116
118
|
}
|
|
117
119
|
get customObjects() {
|
|
118
120
|
var _a;
|
|
119
|
-
return ((_a = this._customObjects) !== null && _a !== void 0 ? _a : (this._customObjects = new
|
|
121
|
+
return ((_a = this._customObjects) !== null && _a !== void 0 ? _a : (this._customObjects = new Client_js_8.CustomObjectsClient(this._options)));
|
|
120
122
|
}
|
|
121
123
|
get contacts() {
|
|
122
124
|
var _a;
|
|
123
|
-
return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new
|
|
125
|
+
return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_5.ContactsClient(this._options)));
|
|
126
|
+
}
|
|
127
|
+
get consentGroups() {
|
|
128
|
+
var _a;
|
|
129
|
+
return ((_a = this._consentGroups) !== null && _a !== void 0 ? _a : (this._consentGroups = new Client_js_4.ConsentGroupsClient(this._options)));
|
|
124
130
|
}
|
|
125
131
|
get conversations() {
|
|
126
132
|
var _a;
|
|
127
|
-
return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new
|
|
133
|
+
return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_6.ConversationsClient(this._options)));
|
|
128
134
|
}
|
|
129
135
|
get ecommerce() {
|
|
130
136
|
var _a;
|
|
131
|
-
return ((_a = this._ecommerce) !== null && _a !== void 0 ? _a : (this._ecommerce = new
|
|
137
|
+
return ((_a = this._ecommerce) !== null && _a !== void 0 ? _a : (this._ecommerce = new Client_js_11.EcommerceClient(this._options)));
|
|
132
138
|
}
|
|
133
139
|
get coupons() {
|
|
134
140
|
var _a;
|
|
135
|
-
return ((_a = this._coupons) !== null && _a !== void 0 ? _a : (this._coupons = new
|
|
141
|
+
return ((_a = this._coupons) !== null && _a !== void 0 ? _a : (this._coupons = new Client_js_7.CouponsClient(this._options)));
|
|
136
142
|
}
|
|
137
143
|
get payments() {
|
|
138
144
|
var _a;
|
|
139
|
-
return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new
|
|
145
|
+
return ((_a = this._payments) !== null && _a !== void 0 ? _a : (this._payments = new Client_js_19.PaymentsClient(this._options)));
|
|
140
146
|
}
|
|
141
147
|
get event() {
|
|
142
148
|
var _a;
|
|
143
|
-
return ((_a = this._event) !== null && _a !== void 0 ? _a : (this._event = new
|
|
149
|
+
return ((_a = this._event) !== null && _a !== void 0 ? _a : (this._event = new Client_js_13.EventClient(this._options)));
|
|
144
150
|
}
|
|
145
151
|
get inboundParsing() {
|
|
146
152
|
var _a;
|
|
147
|
-
return ((_a = this._inboundParsing) !== null && _a !== void 0 ? _a : (this._inboundParsing = new
|
|
153
|
+
return ((_a = this._inboundParsing) !== null && _a !== void 0 ? _a : (this._inboundParsing = new Client_js_16.InboundParsingClient(this._options)));
|
|
148
154
|
}
|
|
149
155
|
get balance() {
|
|
150
156
|
var _a;
|
|
@@ -152,27 +158,31 @@ class BrevoClient {
|
|
|
152
158
|
}
|
|
153
159
|
get program() {
|
|
154
160
|
var _a;
|
|
155
|
-
return ((_a = this._program) !== null && _a !== void 0 ? _a : (this._program = new
|
|
161
|
+
return ((_a = this._program) !== null && _a !== void 0 ? _a : (this._program = new Client_js_21.ProgramClient(this._options)));
|
|
156
162
|
}
|
|
157
163
|
get reward() {
|
|
158
164
|
var _a;
|
|
159
|
-
return ((_a = this._reward) !== null && _a !== void 0 ? _a : (this._reward = new
|
|
165
|
+
return ((_a = this._reward) !== null && _a !== void 0 ? _a : (this._reward = new Client_js_22.RewardClient(this._options)));
|
|
160
166
|
}
|
|
161
167
|
get tier() {
|
|
162
168
|
var _a;
|
|
163
|
-
return ((_a = this._tier) !== null && _a !== void 0 ? _a : (this._tier = new
|
|
169
|
+
return ((_a = this._tier) !== null && _a !== void 0 ? _a : (this._tier = new Client_js_27.TierClient(this._options)));
|
|
170
|
+
}
|
|
171
|
+
get wallet() {
|
|
172
|
+
var _a;
|
|
173
|
+
return ((_a = this._wallet) !== null && _a !== void 0 ? _a : (this._wallet = new Client_js_32.WalletClient(this._options)));
|
|
164
174
|
}
|
|
165
175
|
get emailCampaigns() {
|
|
166
176
|
var _a;
|
|
167
|
-
return ((_a = this._emailCampaigns) !== null && _a !== void 0 ? _a : (this._emailCampaigns = new
|
|
177
|
+
return ((_a = this._emailCampaigns) !== null && _a !== void 0 ? _a : (this._emailCampaigns = new Client_js_12.EmailCampaignsClient(this._options)));
|
|
168
178
|
}
|
|
169
179
|
get smsCampaigns() {
|
|
170
180
|
var _a;
|
|
171
|
-
return ((_a = this._smsCampaigns) !== null && _a !== void 0 ? _a : (this._smsCampaigns = new
|
|
181
|
+
return ((_a = this._smsCampaigns) !== null && _a !== void 0 ? _a : (this._smsCampaigns = new Client_js_24.SmsCampaignsClient(this._options)));
|
|
172
182
|
}
|
|
173
183
|
get whatsAppCampaigns() {
|
|
174
184
|
var _a;
|
|
175
|
-
return ((_a = this._whatsAppCampaigns) !== null && _a !== void 0 ? _a : (this._whatsAppCampaigns = new
|
|
185
|
+
return ((_a = this._whatsAppCampaigns) !== null && _a !== void 0 ? _a : (this._whatsAppCampaigns = new Client_js_34.WhatsAppCampaignsClient(this._options)));
|
|
176
186
|
}
|
|
177
187
|
get companies() {
|
|
178
188
|
var _a;
|
|
@@ -180,35 +190,35 @@ class BrevoClient {
|
|
|
180
190
|
}
|
|
181
191
|
get deals() {
|
|
182
192
|
var _a;
|
|
183
|
-
return ((_a = this._deals) !== null && _a !== void 0 ? _a : (this._deals = new
|
|
193
|
+
return ((_a = this._deals) !== null && _a !== void 0 ? _a : (this._deals = new Client_js_9.DealsClient(this._options)));
|
|
184
194
|
}
|
|
185
195
|
get files() {
|
|
186
196
|
var _a;
|
|
187
|
-
return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new
|
|
197
|
+
return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new Client_js_15.FilesClient(this._options)));
|
|
188
198
|
}
|
|
189
199
|
get notes() {
|
|
190
200
|
var _a;
|
|
191
|
-
return ((_a = this._notes) !== null && _a !== void 0 ? _a : (this._notes = new
|
|
201
|
+
return ((_a = this._notes) !== null && _a !== void 0 ? _a : (this._notes = new Client_js_18.NotesClient(this._options)));
|
|
192
202
|
}
|
|
193
203
|
get tasks() {
|
|
194
204
|
var _a;
|
|
195
|
-
return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new
|
|
205
|
+
return ((_a = this._tasks) !== null && _a !== void 0 ? _a : (this._tasks = new Client_js_26.TasksClient(this._options)));
|
|
196
206
|
}
|
|
197
207
|
get transactionalWhatsApp() {
|
|
198
208
|
var _a;
|
|
199
|
-
return ((_a = this._transactionalWhatsApp) !== null && _a !== void 0 ? _a : (this._transactionalWhatsApp = new
|
|
209
|
+
return ((_a = this._transactionalWhatsApp) !== null && _a !== void 0 ? _a : (this._transactionalWhatsApp = new Client_js_30.TransactionalWhatsAppClient(this._options)));
|
|
200
210
|
}
|
|
201
211
|
get transactionalEmails() {
|
|
202
212
|
var _a;
|
|
203
|
-
return ((_a = this._transactionalEmails) !== null && _a !== void 0 ? _a : (this._transactionalEmails = new
|
|
213
|
+
return ((_a = this._transactionalEmails) !== null && _a !== void 0 ? _a : (this._transactionalEmails = new Client_js_28.TransactionalEmailsClient(this._options)));
|
|
204
214
|
}
|
|
205
215
|
get transactionalSms() {
|
|
206
216
|
var _a;
|
|
207
|
-
return ((_a = this._transactionalSms) !== null && _a !== void 0 ? _a : (this._transactionalSms = new
|
|
217
|
+
return ((_a = this._transactionalSms) !== null && _a !== void 0 ? _a : (this._transactionalSms = new Client_js_29.TransactionalSmsClient(this._options)));
|
|
208
218
|
}
|
|
209
219
|
get smsTemplates() {
|
|
210
220
|
var _a;
|
|
211
|
-
return ((_a = this._smsTemplates) !== null && _a !== void 0 ? _a : (this._smsTemplates = new
|
|
221
|
+
return ((_a = this._smsTemplates) !== null && _a !== void 0 ? _a : (this._smsTemplates = new Client_js_25.SmsTemplatesClient(this._options)));
|
|
212
222
|
}
|
|
213
223
|
/**
|
|
214
224
|
* Make a passthrough request using the SDK's configured auth, retry, logging, etc.
|
|
@@ -48,7 +48,7 @@ class BadRequestError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "BadRequestError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.BadRequestError = BadRequestError;
|
|
@@ -48,7 +48,7 @@ class ConflictError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "ConflictError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.ConflictError = ConflictError;
|
|
@@ -48,7 +48,7 @@ class ExpectationFailedError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "ExpectationFailedError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.ExpectationFailedError = ExpectationFailedError;
|
|
@@ -48,7 +48,7 @@ class FailedDependencyError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "FailedDependencyError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.FailedDependencyError = FailedDependencyError;
|
|
@@ -48,7 +48,7 @@ class ForbiddenError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "ForbiddenError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.ForbiddenError = ForbiddenError;
|
|
@@ -48,7 +48,7 @@ class InternalServerError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "InternalServerError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.InternalServerError = InternalServerError;
|
|
@@ -48,7 +48,7 @@ class MethodNotAllowedError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "MethodNotAllowedError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.MethodNotAllowedError = MethodNotAllowedError;
|
|
@@ -48,7 +48,7 @@ class NotFoundError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "NotFoundError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.NotFoundError = NotFoundError;
|
|
@@ -48,7 +48,7 @@ class PaymentRequiredError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "PaymentRequiredError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.PaymentRequiredError = PaymentRequiredError;
|
|
@@ -48,7 +48,7 @@ class PreconditionFailedError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "PreconditionFailedError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.PreconditionFailedError = PreconditionFailedError;
|
|
@@ -48,7 +48,7 @@ class TooEarlyError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "TooEarlyError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.TooEarlyError = TooEarlyError;
|
|
@@ -48,7 +48,7 @@ class TooManyRequestsError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "TooManyRequestsError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.TooManyRequestsError = TooManyRequestsError;
|
|
@@ -48,7 +48,7 @@ class UnauthorizedError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "UnauthorizedError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.UnauthorizedError = UnauthorizedError;
|
|
@@ -48,7 +48,7 @@ class UnprocessableEntityError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "UnprocessableEntityError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.UnprocessableEntityError = UnprocessableEntityError;
|
|
@@ -48,7 +48,7 @@ class UnsupportedMediaTypeError extends errors.BrevoError {
|
|
|
48
48
|
if (Error.captureStackTrace) {
|
|
49
49
|
Error.captureStackTrace(this, this.constructor);
|
|
50
50
|
}
|
|
51
|
-
this.name =
|
|
51
|
+
this.name = "UnsupportedMediaTypeError";
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.UnsupportedMediaTypeError = UnsupportedMediaTypeError;
|
|
@@ -47,7 +47,7 @@ export declare class BalanceClient {
|
|
|
47
47
|
* pid: "pid"
|
|
48
48
|
* })
|
|
49
49
|
*/
|
|
50
|
-
getBalanceDefinitionList(request: Brevo.GetBalanceDefinitionListRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetBalanceDefinitionListResponse>;
|
|
50
|
+
getBalanceDefinitionList(request: Brevo.GetBalanceDefinitionListRequest, requestOptions?: BalanceClient.RequestOptions): core.HttpResponsePromise<Brevo.GetBalanceDefinitionListResponse | undefined>;
|
|
51
51
|
private __getBalanceDefinitionList;
|
|
52
52
|
/**
|
|
53
53
|
* Creates balance definition and returns information
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
|
+
import * as core from "../../../../core/index.js";
|
|
4
|
+
import * as Brevo from "../../../index.js";
|
|
5
|
+
export declare namespace ConsentGroupsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class ConsentGroupsClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ConsentGroupsClient.Options>;
|
|
12
|
+
constructor(options: ConsentGroupsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Returns a paginated list of consent groups for the account.
|
|
15
|
+
*
|
|
16
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.</Note>
|
|
17
|
+
*
|
|
18
|
+
* @param {Brevo.GetConsentGroupsRequest} request
|
|
19
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
20
|
+
*
|
|
21
|
+
* @throws {@link Brevo.BadRequestError}
|
|
22
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
23
|
+
* @throws {@link Brevo.TooManyRequestsError}
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* await client.consentGroups.getConsentGroups()
|
|
27
|
+
*/
|
|
28
|
+
getConsentGroups(request?: Brevo.GetConsentGroupsRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroupsListResponse>;
|
|
29
|
+
private __getConsentGroups;
|
|
30
|
+
/**
|
|
31
|
+
* Creates a new consent group for the account.
|
|
32
|
+
*
|
|
33
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
34
|
+
*
|
|
35
|
+
* @param {Brevo.CreateConsentGroupRequest} request
|
|
36
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link Brevo.BadRequestError}
|
|
39
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
40
|
+
* @throws {@link Brevo.ConflictError}
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* await client.consentGroups.createConsentGroup({
|
|
44
|
+
* name: "Newsletter EU",
|
|
45
|
+
* signupMode: "manual"
|
|
46
|
+
* })
|
|
47
|
+
*/
|
|
48
|
+
createConsentGroup(request: Brevo.CreateConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
49
|
+
private __createConsentGroup;
|
|
50
|
+
/**
|
|
51
|
+
* Returns a single consent group by ID for the account.
|
|
52
|
+
*
|
|
53
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
54
|
+
*
|
|
55
|
+
* @param {Brevo.GetConsentGroupRequest} request
|
|
56
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link Brevo.BadRequestError}
|
|
59
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
60
|
+
* @throws {@link Brevo.NotFoundError}
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* await client.consentGroups.getConsentGroup({
|
|
64
|
+
* id: 1000000
|
|
65
|
+
* })
|
|
66
|
+
*/
|
|
67
|
+
getConsentGroup(request: Brevo.GetConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
68
|
+
private __getConsentGroup;
|
|
69
|
+
/**
|
|
70
|
+
* Updates name, description, or signupMode of a consent group. At least one field must be provided.
|
|
71
|
+
*
|
|
72
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
73
|
+
*
|
|
74
|
+
* @param {Brevo.UpdateConsentGroupRequest} request
|
|
75
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link Brevo.BadRequestError}
|
|
78
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
79
|
+
* @throws {@link Brevo.NotFoundError}
|
|
80
|
+
* @throws {@link Brevo.ConflictError}
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* await client.consentGroups.updateConsentGroup({
|
|
84
|
+
* id: 1000000
|
|
85
|
+
* })
|
|
86
|
+
*/
|
|
87
|
+
updateConsentGroup(request: Brevo.UpdateConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<Brevo.ConsentGroup>;
|
|
88
|
+
private __updateConsentGroup;
|
|
89
|
+
/**
|
|
90
|
+
* Deletes a consent group by ID and removes it from all associated contacts.
|
|
91
|
+
*
|
|
92
|
+
* <Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>
|
|
93
|
+
*
|
|
94
|
+
* @param {Brevo.DeleteConsentGroupRequest} request
|
|
95
|
+
* @param {ConsentGroupsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link Brevo.BadRequestError}
|
|
98
|
+
* @throws {@link Brevo.ForbiddenError}
|
|
99
|
+
* @throws {@link Brevo.NotFoundError}
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* await client.consentGroups.deleteConsentGroup({
|
|
103
|
+
* id: 1000000
|
|
104
|
+
* })
|
|
105
|
+
*/
|
|
106
|
+
deleteConsentGroup(request: Brevo.DeleteConsentGroupRequest, requestOptions?: ConsentGroupsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
107
|
+
private __deleteConsentGroup;
|
|
108
|
+
}
|