@trycourier/courier 6.4.0 → 6.4.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/Client.d.ts +14 -48
- package/Client.js +20 -49
- package/README.md +113 -808
- package/api/client/requests/SendMessageRequest.d.ts +12 -47
- package/api/resources/audiences/client/Client.d.ts +10 -5
- package/api/resources/audiences/client/Client.js +45 -15
- package/api/resources/auditEvents/client/Client.d.ts +4 -2
- package/api/resources/auditEvents/client/Client.js +17 -5
- package/api/resources/authTokens/client/Client.d.ts +2 -1
- package/api/resources/authTokens/client/Client.js +8 -2
- package/api/resources/automations/client/Client.d.ts +4 -2
- package/api/resources/automations/client/Client.js +16 -4
- package/api/resources/brands/client/Client.d.ts +10 -5
- package/api/resources/brands/client/Client.js +45 -15
- package/api/resources/bulk/client/Client.d.ts +10 -5
- package/api/resources/bulk/client/Client.js +45 -15
- package/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
- package/api/resources/commons/errors/AlreadyExistsError.js +2 -1
- package/api/resources/commons/errors/BadRequestError.d.ts +2 -1
- package/api/resources/commons/errors/BadRequestError.js +2 -1
- package/api/resources/commons/errors/ConflictError.d.ts +2 -1
- package/api/resources/commons/errors/ConflictError.js +2 -1
- package/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
- package/api/resources/commons/errors/MessageNotFoundError.js +2 -1
- package/api/resources/commons/errors/NotFoundError.d.ts +2 -1
- package/api/resources/commons/errors/NotFoundError.js +2 -1
- package/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
- package/api/resources/commons/errors/PaymentRequiredError.js +2 -1
- package/api/resources/inbound/client/Client.d.ts +2 -1
- package/api/resources/inbound/client/Client.js +10 -4
- package/api/resources/lists/client/Client.d.ts +20 -10
- package/api/resources/lists/client/Client.js +89 -29
- package/api/resources/messages/client/Client.d.ts +12 -6
- package/api/resources/messages/client/Client.js +56 -20
- package/api/resources/notifications/client/Client.d.ts +12 -6
- package/api/resources/notifications/client/Client.js +58 -13
- package/api/resources/profiles/client/Client.d.ts +16 -8
- package/api/resources/profiles/client/Client.js +75 -24
- package/api/resources/templates/client/Client.d.ts +2 -1
- package/api/resources/templates/client/Client.js +9 -3
- package/api/resources/tenants/client/Client.d.ts +14 -7
- package/api/resources/tenants/client/Client.js +61 -19
- package/api/resources/translations/client/Client.d.ts +4 -2
- package/api/resources/translations/client/Client.js +18 -6
- package/api/resources/users/resources/preferences/client/Client.d.ts +6 -3
- package/api/resources/users/resources/preferences/client/Client.js +38 -11
- package/api/resources/users/resources/tenants/client/Client.d.ts +10 -5
- package/api/resources/users/resources/tenants/client/Client.js +45 -12
- package/api/resources/users/resources/tokens/client/Client.d.ts +12 -6
- package/api/resources/users/resources/tokens/client/Client.js +53 -17
- package/core/fetcher/APIResponse.d.ts +10 -0
- package/core/fetcher/Fetcher.js +7 -0
- package/core/fetcher/Headers.d.ts +2 -0
- package/core/fetcher/Headers.js +84 -0
- package/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/core/fetcher/HttpResponsePromise.js +103 -0
- package/core/fetcher/RawResponse.d.ts +29 -0
- package/core/fetcher/RawResponse.js +44 -0
- package/core/fetcher/index.d.ts +3 -0
- package/core/fetcher/index.js +7 -1
- package/core/index.d.ts +1 -1
- package/core/index.js +1 -1
- package/dist/Client.d.ts +14 -48
- package/dist/Client.js +20 -49
- package/dist/api/client/requests/SendMessageRequest.d.ts +12 -47
- package/dist/api/resources/audiences/client/Client.d.ts +10 -5
- package/dist/api/resources/audiences/client/Client.js +45 -15
- package/dist/api/resources/auditEvents/client/Client.d.ts +4 -2
- package/dist/api/resources/auditEvents/client/Client.js +17 -5
- package/dist/api/resources/authTokens/client/Client.d.ts +2 -1
- package/dist/api/resources/authTokens/client/Client.js +8 -2
- package/dist/api/resources/automations/client/Client.d.ts +4 -2
- package/dist/api/resources/automations/client/Client.js +16 -4
- package/dist/api/resources/brands/client/Client.d.ts +10 -5
- package/dist/api/resources/brands/client/Client.js +45 -15
- package/dist/api/resources/bulk/client/Client.d.ts +10 -5
- package/dist/api/resources/bulk/client/Client.js +45 -15
- package/dist/api/resources/commons/errors/AlreadyExistsError.d.ts +2 -1
- package/dist/api/resources/commons/errors/AlreadyExistsError.js +2 -1
- package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -1
- package/dist/api/resources/commons/errors/BadRequestError.js +2 -1
- package/dist/api/resources/commons/errors/ConflictError.d.ts +2 -1
- package/dist/api/resources/commons/errors/ConflictError.js +2 -1
- package/dist/api/resources/commons/errors/MessageNotFoundError.d.ts +2 -1
- package/dist/api/resources/commons/errors/MessageNotFoundError.js +2 -1
- package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -1
- package/dist/api/resources/commons/errors/NotFoundError.js +2 -1
- package/dist/api/resources/commons/errors/PaymentRequiredError.d.ts +2 -1
- package/dist/api/resources/commons/errors/PaymentRequiredError.js +2 -1
- package/dist/api/resources/inbound/client/Client.d.ts +2 -1
- package/dist/api/resources/inbound/client/Client.js +10 -4
- package/dist/api/resources/lists/client/Client.d.ts +20 -10
- package/dist/api/resources/lists/client/Client.js +89 -29
- package/dist/api/resources/messages/client/Client.d.ts +12 -6
- package/dist/api/resources/messages/client/Client.js +56 -20
- package/dist/api/resources/notifications/client/Client.d.ts +12 -6
- package/dist/api/resources/notifications/client/Client.js +58 -13
- package/dist/api/resources/profiles/client/Client.d.ts +16 -8
- package/dist/api/resources/profiles/client/Client.js +75 -24
- package/dist/api/resources/templates/client/Client.d.ts +2 -1
- package/dist/api/resources/templates/client/Client.js +9 -3
- package/dist/api/resources/tenants/client/Client.d.ts +14 -7
- package/dist/api/resources/tenants/client/Client.js +61 -19
- package/dist/api/resources/translations/client/Client.d.ts +4 -2
- package/dist/api/resources/translations/client/Client.js +18 -6
- package/dist/api/resources/users/resources/preferences/client/Client.d.ts +6 -3
- package/dist/api/resources/users/resources/preferences/client/Client.js +38 -11
- package/dist/api/resources/users/resources/tenants/client/Client.d.ts +10 -5
- package/dist/api/resources/users/resources/tenants/client/Client.js +45 -12
- package/dist/api/resources/users/resources/tokens/client/Client.d.ts +12 -6
- package/dist/api/resources/users/resources/tokens/client/Client.js +53 -17
- package/dist/core/fetcher/APIResponse.d.ts +10 -0
- package/dist/core/fetcher/Fetcher.js +7 -0
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +84 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +44 -0
- package/dist/core/fetcher/index.d.ts +3 -0
- package/dist/core/fetcher/index.js +7 -1
- package/dist/core/index.d.ts +1 -1
- package/dist/core/index.js +1 -1
- package/dist/errors/CourierError.d.ts +4 -1
- package/dist/errors/CourierError.js +4 -7
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/errors/CourierError.d.ts +4 -1
- package/errors/CourierError.js +4 -7
- package/package.json +3 -2
- package/reference.md +12 -50
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.unknownRawResponse = exports.abortRawResponse = void 0;
|
|
4
|
+
exports.toRawResponse = toRawResponse;
|
|
5
|
+
const Headers_1 = require("./Headers");
|
|
6
|
+
/**
|
|
7
|
+
* A raw response indicating that the request was aborted.
|
|
8
|
+
*/
|
|
9
|
+
exports.abortRawResponse = {
|
|
10
|
+
headers: new Headers_1.Headers(),
|
|
11
|
+
redirected: false,
|
|
12
|
+
status: 499,
|
|
13
|
+
statusText: "Client Closed Request",
|
|
14
|
+
type: "error",
|
|
15
|
+
url: "",
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* A raw response indicating an unknown error.
|
|
19
|
+
*/
|
|
20
|
+
exports.unknownRawResponse = {
|
|
21
|
+
headers: new Headers_1.Headers(),
|
|
22
|
+
redirected: false,
|
|
23
|
+
status: 0,
|
|
24
|
+
statusText: "Unknown Error",
|
|
25
|
+
type: "error",
|
|
26
|
+
url: "",
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Converts a `RawResponse` object into a `RawResponse` by extracting its properties,
|
|
30
|
+
* excluding the `body` and `bodyUsed` fields.
|
|
31
|
+
*
|
|
32
|
+
* @param response - The `RawResponse` object to convert.
|
|
33
|
+
* @returns A `RawResponse` object containing the extracted properties of the input response.
|
|
34
|
+
*/
|
|
35
|
+
function toRawResponse(response) {
|
|
36
|
+
return {
|
|
37
|
+
headers: response.headers,
|
|
38
|
+
redirected: response.redirected,
|
|
39
|
+
status: response.status,
|
|
40
|
+
statusText: response.statusText,
|
|
41
|
+
type: response.type,
|
|
42
|
+
url: response.url,
|
|
43
|
+
};
|
|
44
|
+
}
|
|
@@ -3,3 +3,6 @@ export { fetcher } from "./Fetcher";
|
|
|
3
3
|
export type { Fetcher, FetchFunction } from "./Fetcher";
|
|
4
4
|
export { getHeader } from "./getHeader";
|
|
5
5
|
export { Supplier } from "./Supplier";
|
|
6
|
+
export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse";
|
|
7
|
+
export type { RawResponse, WithRawResponse } from "./RawResponse";
|
|
8
|
+
export { HttpResponsePromise } from "./HttpResponsePromise";
|
|
@@ -1,9 +1,15 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Supplier = exports.getHeader = exports.fetcher = void 0;
|
|
3
|
+
exports.HttpResponsePromise = exports.unknownRawResponse = exports.toRawResponse = exports.abortRawResponse = exports.Supplier = exports.getHeader = exports.fetcher = void 0;
|
|
4
4
|
var Fetcher_1 = require("./Fetcher");
|
|
5
5
|
Object.defineProperty(exports, "fetcher", { enumerable: true, get: function () { return Fetcher_1.fetcher; } });
|
|
6
6
|
var getHeader_1 = require("./getHeader");
|
|
7
7
|
Object.defineProperty(exports, "getHeader", { enumerable: true, get: function () { return getHeader_1.getHeader; } });
|
|
8
8
|
var Supplier_1 = require("./Supplier");
|
|
9
9
|
Object.defineProperty(exports, "Supplier", { enumerable: true, get: function () { return Supplier_1.Supplier; } });
|
|
10
|
+
var RawResponse_1 = require("./RawResponse");
|
|
11
|
+
Object.defineProperty(exports, "abortRawResponse", { enumerable: true, get: function () { return RawResponse_1.abortRawResponse; } });
|
|
12
|
+
Object.defineProperty(exports, "toRawResponse", { enumerable: true, get: function () { return RawResponse_1.toRawResponse; } });
|
|
13
|
+
Object.defineProperty(exports, "unknownRawResponse", { enumerable: true, get: function () { return RawResponse_1.unknownRawResponse; } });
|
|
14
|
+
var HttpResponsePromise_1 = require("./HttpResponsePromise");
|
|
15
|
+
Object.defineProperty(exports, "HttpResponsePromise", { enumerable: true, get: function () { return HttpResponsePromise_1.HttpResponsePromise; } });
|
package/dist/core/index.d.ts
CHANGED
package/dist/core/index.js
CHANGED
|
@@ -15,5 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./fetcher"), exports);
|
|
18
|
-
__exportStar(require("./auth"), exports);
|
|
19
18
|
__exportStar(require("./runtime"), exports);
|
|
19
|
+
__exportStar(require("./auth"), exports);
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as core from "../core";
|
|
4
5
|
export declare class CourierError extends Error {
|
|
5
6
|
readonly statusCode?: number;
|
|
6
7
|
readonly body?: unknown;
|
|
7
|
-
|
|
8
|
+
readonly rawResponse?: core.RawResponse;
|
|
9
|
+
constructor({ message, statusCode, body, rawResponse, }: {
|
|
8
10
|
message?: string;
|
|
9
11
|
statusCode?: number;
|
|
10
12
|
body?: unknown;
|
|
13
|
+
rawResponse?: core.RawResponse;
|
|
11
14
|
});
|
|
12
15
|
}
|
|
@@ -6,15 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
exports.CourierError = void 0;
|
|
7
7
|
const json_1 = require("../core/json");
|
|
8
8
|
class CourierError extends Error {
|
|
9
|
-
constructor({ message, statusCode, body }) {
|
|
9
|
+
constructor({ message, statusCode, body, rawResponse, }) {
|
|
10
10
|
super(buildMessage({ message, statusCode, body }));
|
|
11
11
|
Object.setPrototypeOf(this, CourierError.prototype);
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
if (body !== undefined) {
|
|
16
|
-
this.body = body;
|
|
17
|
-
}
|
|
12
|
+
this.statusCode = statusCode;
|
|
13
|
+
this.body = body;
|
|
14
|
+
this.rawResponse = rawResponse;
|
|
18
15
|
}
|
|
19
16
|
}
|
|
20
17
|
exports.CourierError = CourierError;
|
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "6.4.
|
|
1
|
+
export declare const SDK_VERSION = "6.4.2";
|
package/dist/version.js
CHANGED
package/errors/CourierError.d.ts
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as core from "../core";
|
|
4
5
|
export declare class CourierError extends Error {
|
|
5
6
|
readonly statusCode?: number;
|
|
6
7
|
readonly body?: unknown;
|
|
7
|
-
|
|
8
|
+
readonly rawResponse?: core.RawResponse;
|
|
9
|
+
constructor({ message, statusCode, body, rawResponse, }: {
|
|
8
10
|
message?: string;
|
|
9
11
|
statusCode?: number;
|
|
10
12
|
body?: unknown;
|
|
13
|
+
rawResponse?: core.RawResponse;
|
|
11
14
|
});
|
|
12
15
|
}
|
package/errors/CourierError.js
CHANGED
|
@@ -6,15 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
exports.CourierError = void 0;
|
|
7
7
|
const json_1 = require("../core/json");
|
|
8
8
|
class CourierError extends Error {
|
|
9
|
-
constructor({ message, statusCode, body }) {
|
|
9
|
+
constructor({ message, statusCode, body, rawResponse, }) {
|
|
10
10
|
super(buildMessage({ message, statusCode, body }));
|
|
11
11
|
Object.setPrototypeOf(this, CourierError.prototype);
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
if (body !== undefined) {
|
|
16
|
-
this.body = body;
|
|
17
|
-
}
|
|
12
|
+
this.statusCode = statusCode;
|
|
13
|
+
this.body = body;
|
|
14
|
+
this.rawResponse = rawResponse;
|
|
18
15
|
}
|
|
19
16
|
}
|
|
20
17
|
exports.CourierError = CourierError;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@trycourier/courier",
|
|
3
|
-
"version": "6.4.
|
|
3
|
+
"version": "6.4.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": "https://github.com/trycourier/courier-node",
|
|
6
6
|
"main": "./index.js",
|
|
@@ -39,5 +39,6 @@
|
|
|
39
39
|
"fs": false,
|
|
40
40
|
"os": false,
|
|
41
41
|
"path": false
|
|
42
|
-
}
|
|
42
|
+
},
|
|
43
|
+
"packageManager": "yarn@1.22.22"
|
|
43
44
|
}
|
package/reference.md
CHANGED
|
@@ -30,57 +30,19 @@ Use the send API to send a message to one or more recipients.
|
|
|
30
30
|
```typescript
|
|
31
31
|
await client.send({
|
|
32
32
|
message: {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
context: undefined,
|
|
37
|
-
metadata: undefined,
|
|
38
|
-
preferences: undefined,
|
|
39
|
-
providers: undefined,
|
|
40
|
-
routing: undefined,
|
|
41
|
-
timeout: undefined,
|
|
42
|
-
delay: undefined,
|
|
43
|
-
expiry: undefined,
|
|
44
|
-
to: undefined,
|
|
33
|
+
to: {
|
|
34
|
+
email: "email@example.com",
|
|
35
|
+
},
|
|
45
36
|
content: {
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
content: "content",
|
|
56
|
-
align: "left",
|
|
57
|
-
text_style: undefined,
|
|
58
|
-
color: undefined,
|
|
59
|
-
bold: undefined,
|
|
60
|
-
italic: undefined,
|
|
61
|
-
strikethrough: undefined,
|
|
62
|
-
underline: undefined,
|
|
63
|
-
locales: undefined,
|
|
64
|
-
format: undefined,
|
|
65
|
-
},
|
|
66
|
-
{
|
|
67
|
-
type: "text",
|
|
68
|
-
channels: undefined,
|
|
69
|
-
ref: undefined,
|
|
70
|
-
if: undefined,
|
|
71
|
-
loop: undefined,
|
|
72
|
-
content: "content",
|
|
73
|
-
align: "left",
|
|
74
|
-
text_style: undefined,
|
|
75
|
-
color: undefined,
|
|
76
|
-
bold: undefined,
|
|
77
|
-
italic: undefined,
|
|
78
|
-
strikethrough: undefined,
|
|
79
|
-
underline: undefined,
|
|
80
|
-
locales: undefined,
|
|
81
|
-
format: undefined,
|
|
82
|
-
},
|
|
83
|
-
],
|
|
37
|
+
title: "Welcome!",
|
|
38
|
+
body: "Thanks for signing up, {{name}}",
|
|
39
|
+
},
|
|
40
|
+
data: {
|
|
41
|
+
name: "Peter Parker",
|
|
42
|
+
},
|
|
43
|
+
routing: {
|
|
44
|
+
method: "single",
|
|
45
|
+
channels: ["email"],
|
|
84
46
|
},
|
|
85
47
|
},
|
|
86
48
|
});
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "6.4.
|
|
1
|
+
export declare const SDK_VERSION = "6.4.2";
|
package/version.js
CHANGED