@getbrevo/brevo 4.0.1 → 5.0.0
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/README.md +6 -6
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/tier/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tier/client/Client.js +2 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/tier/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tier/client/Client.mjs +2 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +2 -2
package/README.md
CHANGED
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install getbrevo/brevo
|
|
16
|
+
npm install getbrevo/brevo
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Quick Start
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
|
-
import { BrevoClient } from 'getbrevo/brevo
|
|
22
|
+
import { BrevoClient } from 'getbrevo/brevo';
|
|
23
23
|
|
|
24
24
|
const brevo = new BrevoClient({
|
|
25
25
|
apiKey: 'your-api-key',
|
|
@@ -54,7 +54,7 @@ const brevo = new BrevoClient({
|
|
|
54
54
|
The SDK throws specific error types based on HTTP status codes.
|
|
55
55
|
|
|
56
56
|
```typescript
|
|
57
|
-
import { BrevoError, UnauthorizedError, TooManyRequestsError } from 'getbrevo/brevo
|
|
57
|
+
import { BrevoError, UnauthorizedError, TooManyRequestsError } from 'getbrevo/brevo';
|
|
58
58
|
|
|
59
59
|
try {
|
|
60
60
|
await brevo.transactionalEmails.sendTransacEmail({...});
|
|
@@ -241,7 +241,7 @@ URL.revokeObjectURL(url);
|
|
|
241
241
|
All request and response types are exported.
|
|
242
242
|
|
|
243
243
|
```typescript
|
|
244
|
-
import { Brevo } from 'getbrevo/brevo
|
|
244
|
+
import { Brevo } from 'getbrevo/brevo';
|
|
245
245
|
|
|
246
246
|
const request: Brevo.SendTransacEmailRequest = {
|
|
247
247
|
subject: "First email",
|
|
@@ -256,7 +256,7 @@ const request: Brevo.SendTransacEmailRequest = {
|
|
|
256
256
|
## Logging
|
|
257
257
|
|
|
258
258
|
```typescript
|
|
259
|
-
import { BrevoClient, logging } from 'getbrevo/brevo
|
|
259
|
+
import { BrevoClient, logging } from 'getbrevo/brevo';
|
|
260
260
|
|
|
261
261
|
const brevo = new BrevoClient({
|
|
262
262
|
apiKey: 'your-api-key',
|
|
@@ -391,7 +391,7 @@ emailAPI.sendTransacEmail(message);
|
|
|
391
391
|
|
|
392
392
|
**v4.x:**
|
|
393
393
|
```typescript
|
|
394
|
-
import { BrevoClient } from 'getbrevo/brevo
|
|
394
|
+
import { BrevoClient } from 'getbrevo/brevo';
|
|
395
395
|
|
|
396
396
|
const brevo = new BrevoClient({
|
|
397
397
|
apiKey: 'xkeysib-xxx'
|
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": "
|
|
47
|
-
"User-Agent": "@getbrevo/brevo/
|
|
46
|
+
"X-Fern-SDK-Version": "5.0.0",
|
|
47
|
+
"User-Agent": "@getbrevo/brevo/5.0.0",
|
|
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);
|
|
@@ -136,7 +136,7 @@ export declare class TierClient {
|
|
|
136
136
|
* gid: "gid"
|
|
137
137
|
* })
|
|
138
138
|
*/
|
|
139
|
-
deleteTierGroup(request: Brevo.DeleteTierGroupRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<
|
|
139
|
+
deleteTierGroup(request: Brevo.DeleteTierGroupRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
140
140
|
private __deleteTierGroup;
|
|
141
141
|
/**
|
|
142
142
|
* Creates a new tier in a loyalty program tier group. *(The changes will take effect with the next publication of the loyalty program)*
|
|
@@ -220,6 +220,6 @@ export declare class TierClient {
|
|
|
220
220
|
* tid: "tid"
|
|
221
221
|
* })
|
|
222
222
|
*/
|
|
223
|
-
deleteTier(request: Brevo.DeleteTierRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<
|
|
223
|
+
deleteTier(request: Brevo.DeleteTierRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
224
224
|
private __deleteTier;
|
|
225
225
|
}
|
|
@@ -451,7 +451,7 @@ class TierClient {
|
|
|
451
451
|
logging: this._options.logging,
|
|
452
452
|
});
|
|
453
453
|
if (_response.ok) {
|
|
454
|
-
return { data:
|
|
454
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
455
455
|
}
|
|
456
456
|
if (_response.error.reason === "status-code") {
|
|
457
457
|
switch (_response.error.statusCode) {
|
|
@@ -722,7 +722,7 @@ class TierClient {
|
|
|
722
722
|
logging: this._options.logging,
|
|
723
723
|
});
|
|
724
724
|
if (_response.ok) {
|
|
725
|
-
return { data:
|
|
725
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
726
726
|
}
|
|
727
727
|
if (_response.error.reason === "status-code") {
|
|
728
728
|
switch (_response.error.statusCode) {
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "5.0.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@getbrevo/brevo",
|
|
9
|
-
"X-Fern-SDK-Version": "
|
|
10
|
-
"User-Agent": "@getbrevo/brevo/
|
|
9
|
+
"X-Fern-SDK-Version": "5.0.0",
|
|
10
|
+
"User-Agent": "@getbrevo/brevo/5.0.0",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -136,7 +136,7 @@ export declare class TierClient {
|
|
|
136
136
|
* gid: "gid"
|
|
137
137
|
* })
|
|
138
138
|
*/
|
|
139
|
-
deleteTierGroup(request: Brevo.DeleteTierGroupRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<
|
|
139
|
+
deleteTierGroup(request: Brevo.DeleteTierGroupRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
140
140
|
private __deleteTierGroup;
|
|
141
141
|
/**
|
|
142
142
|
* Creates a new tier in a loyalty program tier group. *(The changes will take effect with the next publication of the loyalty program)*
|
|
@@ -220,6 +220,6 @@ export declare class TierClient {
|
|
|
220
220
|
* tid: "tid"
|
|
221
221
|
* })
|
|
222
222
|
*/
|
|
223
|
-
deleteTier(request: Brevo.DeleteTierRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<
|
|
223
|
+
deleteTier(request: Brevo.DeleteTierRequest, requestOptions?: TierClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
224
224
|
private __deleteTier;
|
|
225
225
|
}
|
|
@@ -415,7 +415,7 @@ export class TierClient {
|
|
|
415
415
|
logging: this._options.logging,
|
|
416
416
|
});
|
|
417
417
|
if (_response.ok) {
|
|
418
|
-
return { data:
|
|
418
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
419
419
|
}
|
|
420
420
|
if (_response.error.reason === "status-code") {
|
|
421
421
|
switch (_response.error.statusCode) {
|
|
@@ -686,7 +686,7 @@ export class TierClient {
|
|
|
686
686
|
logging: this._options.logging,
|
|
687
687
|
});
|
|
688
688
|
if (_response.ok) {
|
|
689
|
-
return { data:
|
|
689
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
690
690
|
}
|
|
691
691
|
if (_response.error.reason === "status-code") {
|
|
692
692
|
switch (_response.error.statusCode) {
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "
|
|
1
|
+
export declare const SDK_VERSION = "5.0.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "
|
|
1
|
+
export const SDK_VERSION = "5.0.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -11497,7 +11497,7 @@ await client.tier.updateTierGroup({
|
|
|
11497
11497
|
</dl>
|
|
11498
11498
|
</details>
|
|
11499
11499
|
|
|
11500
|
-
<details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTierGroup</a>({ ...params }) ->
|
|
11500
|
+
<details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTierGroup</a>({ ...params }) -> void</code></summary>
|
|
11501
11501
|
<dl>
|
|
11502
11502
|
<dd>
|
|
11503
11503
|
|
|
@@ -11765,7 +11765,7 @@ await client.tier.updateTier({
|
|
|
11765
11765
|
</dl>
|
|
11766
11766
|
</details>
|
|
11767
11767
|
|
|
11768
|
-
<details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTier</a>({ ...params }) ->
|
|
11768
|
+
<details><summary><code>client.tier.<a href="/src/api/resources/tier/client/Client.ts">deleteTier</a>({ ...params }) -> void</code></summary>
|
|
11769
11769
|
<dl>
|
|
11770
11770
|
<dd>
|
|
11771
11771
|
|