rcs-js 1.0.11 → 1.0.13

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.
Files changed (75) hide show
  1. package/Client.js +1 -1
  2. package/api/errors/PaymentRequiredError.d.ts +7 -0
  3. package/api/errors/PaymentRequiredError.js +41 -0
  4. package/api/errors/index.d.ts +1 -0
  5. package/api/errors/index.js +1 -0
  6. package/api/resources/company/client/Client.d.ts +1 -0
  7. package/api/resources/company/client/Client.js +6 -3
  8. package/api/resources/send/client/Client.d.ts +3 -0
  9. package/api/resources/send/client/Client.js +12 -3
  10. package/api/resources/send/client/requests/Rcs.d.ts +9 -0
  11. package/api/resources/send/client/requests/SendMmsRequest.d.ts +2 -0
  12. package/api/resources/send/client/requests/SendSmsRequest.d.ts +2 -0
  13. package/api/resources/send/types/RcsFallback.d.ts +11 -0
  14. package/api/resources/send/types/RcsFallback.js +5 -0
  15. package/api/resources/send/types/index.d.ts +1 -0
  16. package/api/resources/send/types/index.js +1 -0
  17. package/api/types/Action.d.ts +3 -3
  18. package/api/types/PaymentRequiredErrorBody.d.ts +6 -0
  19. package/api/types/PaymentRequiredErrorBody.js +5 -0
  20. package/api/types/index.d.ts +1 -0
  21. package/api/types/index.js +1 -0
  22. package/dist/Client.js +1 -1
  23. package/dist/api/errors/PaymentRequiredError.d.ts +7 -0
  24. package/dist/api/errors/PaymentRequiredError.js +41 -0
  25. package/dist/api/errors/index.d.ts +1 -0
  26. package/dist/api/errors/index.js +1 -0
  27. package/dist/api/resources/company/client/Client.d.ts +1 -0
  28. package/dist/api/resources/company/client/Client.js +6 -3
  29. package/dist/api/resources/send/client/Client.d.ts +3 -0
  30. package/dist/api/resources/send/client/Client.js +12 -3
  31. package/dist/api/resources/send/client/requests/Rcs.d.ts +9 -0
  32. package/dist/api/resources/send/client/requests/SendMmsRequest.d.ts +2 -0
  33. package/dist/api/resources/send/client/requests/SendSmsRequest.d.ts +2 -0
  34. package/dist/api/resources/send/types/RcsFallback.d.ts +11 -0
  35. package/dist/api/resources/send/types/RcsFallback.js +5 -0
  36. package/dist/api/resources/send/types/index.d.ts +1 -0
  37. package/dist/api/resources/send/types/index.js +1 -0
  38. package/dist/api/types/Action.d.ts +3 -3
  39. package/dist/api/types/PaymentRequiredErrorBody.d.ts +6 -0
  40. package/dist/api/types/PaymentRequiredErrorBody.js +5 -0
  41. package/dist/api/types/index.d.ts +1 -0
  42. package/dist/api/types/index.js +1 -0
  43. package/dist/serialization/resources/send/client/requests/Rcs.d.ts +3 -0
  44. package/dist/serialization/resources/send/client/requests/Rcs.js +3 -0
  45. package/dist/serialization/resources/send/client/requests/SendMmsRequest.d.ts +1 -0
  46. package/dist/serialization/resources/send/client/requests/SendMmsRequest.js +1 -0
  47. package/dist/serialization/resources/send/client/requests/SendSmsRequest.d.ts +1 -0
  48. package/dist/serialization/resources/send/client/requests/SendSmsRequest.js +1 -0
  49. package/dist/serialization/resources/send/types/RcsFallback.d.ts +14 -0
  50. package/dist/serialization/resources/send/types/RcsFallback.js +35 -0
  51. package/dist/serialization/resources/send/types/index.d.ts +1 -0
  52. package/dist/serialization/resources/send/types/index.js +1 -0
  53. package/dist/serialization/types/PaymentRequiredErrorBody.d.ts +12 -0
  54. package/dist/serialization/types/PaymentRequiredErrorBody.js +33 -0
  55. package/dist/serialization/types/index.d.ts +1 -0
  56. package/dist/serialization/types/index.js +1 -0
  57. package/dist/version.d.ts +1 -1
  58. package/dist/version.js +1 -1
  59. package/package.json +1 -1
  60. package/serialization/resources/send/client/requests/Rcs.d.ts +3 -0
  61. package/serialization/resources/send/client/requests/Rcs.js +3 -0
  62. package/serialization/resources/send/client/requests/SendMmsRequest.d.ts +1 -0
  63. package/serialization/resources/send/client/requests/SendMmsRequest.js +1 -0
  64. package/serialization/resources/send/client/requests/SendSmsRequest.d.ts +1 -0
  65. package/serialization/resources/send/client/requests/SendSmsRequest.js +1 -0
  66. package/serialization/resources/send/types/RcsFallback.d.ts +14 -0
  67. package/serialization/resources/send/types/RcsFallback.js +35 -0
  68. package/serialization/resources/send/types/index.d.ts +1 -0
  69. package/serialization/resources/send/types/index.js +1 -0
  70. package/serialization/types/PaymentRequiredErrorBody.d.ts +12 -0
  71. package/serialization/types/PaymentRequiredErrorBody.js +33 -0
  72. package/serialization/types/index.d.ts +1 -0
  73. package/serialization/types/index.js +1 -0
  74. package/version.d.ts +1 -1
  75. package/version.js +1 -1
package/Client.js CHANGED
@@ -75,7 +75,7 @@ class PinnacleClient {
75
75
  const _response = yield core.fetcher({
76
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "rcs_functionality"),
77
77
  method: "GET",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  queryParameters: _queryParams,
81
81
  requestType: "json",
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ export declare class PaymentRequiredError extends errors.PinnacleError {
6
+ constructor(body?: unknown);
7
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.PaymentRequiredError = void 0;
30
+ const errors = __importStar(require("../../errors/index"));
31
+ class PaymentRequiredError extends errors.PinnacleError {
32
+ constructor(body) {
33
+ super({
34
+ message: "PaymentRequiredError",
35
+ statusCode: 402,
36
+ body: body,
37
+ });
38
+ Object.setPrototypeOf(this, PaymentRequiredError.prototype);
39
+ }
40
+ }
41
+ exports.PaymentRequiredError = PaymentRequiredError;
@@ -1,4 +1,5 @@
1
1
  export * from "./BadRequestError";
2
2
  export * from "./UnauthorizedError";
3
3
  export * from "./InternalServerError";
4
+ export * from "./PaymentRequiredError";
4
5
  export * from "./ForbiddenError";
@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestError"), exports);
18
18
  __exportStar(require("./UnauthorizedError"), exports);
19
19
  __exportStar(require("./InternalServerError"), exports);
20
+ __exportStar(require("./PaymentRequiredError"), exports);
20
21
  __exportStar(require("./ForbiddenError"), exports);
@@ -43,6 +43,7 @@ export declare class Company {
43
43
  *
44
44
  * @throws {@link Pinnacle.BadRequestError}
45
45
  * @throws {@link Pinnacle.UnauthorizedError}
46
+ * @throws {@link Pinnacle.PaymentRequiredError}
46
47
  * @throws {@link Pinnacle.InternalServerError}
47
48
  *
48
49
  * @example
@@ -76,7 +76,7 @@ class Company {
76
76
  const _response = yield core.fetcher({
77
77
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company"),
78
78
  method: "GET",
79
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
80
80
  contentType: "application/json",
81
81
  queryParameters: _queryParams,
82
82
  requestType: "json",
@@ -130,6 +130,7 @@ class Company {
130
130
  *
131
131
  * @throws {@link Pinnacle.BadRequestError}
132
132
  * @throws {@link Pinnacle.UnauthorizedError}
133
+ * @throws {@link Pinnacle.PaymentRequiredError}
133
134
  * @throws {@link Pinnacle.InternalServerError}
134
135
  *
135
136
  * @example
@@ -166,7 +167,7 @@ class Company {
166
167
  const _response = yield core.fetcher({
167
168
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/register"),
168
169
  method: "POST",
169
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
170
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
170
171
  contentType: "application/json",
171
172
  requestType: "json",
172
173
  body: serializers.CompanyRegisterRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -188,6 +189,8 @@ class Company {
188
189
  throw new Pinnacle.BadRequestError(_response.error.body);
189
190
  case 401:
190
191
  throw new Pinnacle.UnauthorizedError(_response.error.body);
192
+ case 402:
193
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
191
194
  case 500:
192
195
  throw new Pinnacle.InternalServerError(_response.error.body);
193
196
  default:
@@ -233,7 +236,7 @@ class Company {
233
236
  const _response = yield core.fetcher({
234
237
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/update"),
235
238
  method: "POST",
236
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
239
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
237
240
  contentType: "application/json",
238
241
  requestType: "json",
239
242
  body: serializers.CompanyUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -31,6 +31,7 @@ export declare class Send {
31
31
  *
32
32
  * @throws {@link Pinnacle.BadRequestError}
33
33
  * @throws {@link Pinnacle.UnauthorizedError}
34
+ * @throws {@link Pinnacle.PaymentRequiredError}
34
35
  * @throws {@link Pinnacle.ForbiddenError}
35
36
  * @throws {@link Pinnacle.InternalServerError}
36
37
  *
@@ -49,6 +50,7 @@ export declare class Send {
49
50
  *
50
51
  * @throws {@link Pinnacle.BadRequestError}
51
52
  * @throws {@link Pinnacle.UnauthorizedError}
53
+ * @throws {@link Pinnacle.PaymentRequiredError}
52
54
  * @throws {@link Pinnacle.ForbiddenError}
53
55
  * @throws {@link Pinnacle.InternalServerError}
54
56
  *
@@ -68,6 +70,7 @@ export declare class Send {
68
70
  *
69
71
  * @throws {@link Pinnacle.BadRequestError}
70
72
  * @throws {@link Pinnacle.UnauthorizedError}
73
+ * @throws {@link Pinnacle.PaymentRequiredError}
71
74
  * @throws {@link Pinnacle.ForbiddenError}
72
75
  * @throws {@link Pinnacle.InternalServerError}
73
76
  *
@@ -59,6 +59,7 @@ class Send {
59
59
  *
60
60
  * @throws {@link Pinnacle.BadRequestError}
61
61
  * @throws {@link Pinnacle.UnauthorizedError}
62
+ * @throws {@link Pinnacle.PaymentRequiredError}
62
63
  * @throws {@link Pinnacle.ForbiddenError}
63
64
  * @throws {@link Pinnacle.InternalServerError}
64
65
  *
@@ -74,7 +75,7 @@ class Send {
74
75
  const _response = yield core.fetcher({
75
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/rcs"),
76
77
  method: "POST",
77
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
79
  contentType: "application/json",
79
80
  requestType: "json",
80
81
  body: serializers.Rcs.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -96,6 +97,8 @@ class Send {
96
97
  throw new Pinnacle.BadRequestError(_response.error.body);
97
98
  case 401:
98
99
  throw new Pinnacle.UnauthorizedError(_response.error.body);
100
+ case 402:
101
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
99
102
  case 403:
100
103
  throw new Pinnacle.ForbiddenError(_response.error.body);
101
104
  case 500:
@@ -130,6 +133,7 @@ class Send {
130
133
  *
131
134
  * @throws {@link Pinnacle.BadRequestError}
132
135
  * @throws {@link Pinnacle.UnauthorizedError}
136
+ * @throws {@link Pinnacle.PaymentRequiredError}
133
137
  * @throws {@link Pinnacle.ForbiddenError}
134
138
  * @throws {@link Pinnacle.InternalServerError}
135
139
  *
@@ -146,7 +150,7 @@ class Send {
146
150
  const _response = yield core.fetcher({
147
151
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/sms"),
148
152
  method: "POST",
149
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
153
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
150
154
  contentType: "application/json",
151
155
  requestType: "json",
152
156
  body: serializers.SendSmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -168,6 +172,8 @@ class Send {
168
172
  throw new Pinnacle.BadRequestError(_response.error.body);
169
173
  case 401:
170
174
  throw new Pinnacle.UnauthorizedError(_response.error.body);
175
+ case 402:
176
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
171
177
  case 403:
172
178
  throw new Pinnacle.ForbiddenError(_response.error.body);
173
179
  case 500:
@@ -202,6 +208,7 @@ class Send {
202
208
  *
203
209
  * @throws {@link Pinnacle.BadRequestError}
204
210
  * @throws {@link Pinnacle.UnauthorizedError}
211
+ * @throws {@link Pinnacle.PaymentRequiredError}
205
212
  * @throws {@link Pinnacle.ForbiddenError}
206
213
  * @throws {@link Pinnacle.InternalServerError}
207
214
  *
@@ -218,7 +225,7 @@ class Send {
218
225
  const _response = yield core.fetcher({
219
226
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/mms"),
220
227
  method: "POST",
221
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
228
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
222
229
  contentType: "application/json",
223
230
  requestType: "json",
224
231
  body: serializers.SendMmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -240,6 +247,8 @@ class Send {
240
247
  throw new Pinnacle.BadRequestError(_response.error.body);
241
248
  case 401:
242
249
  throw new Pinnacle.UnauthorizedError(_response.error.body);
250
+ case 402:
251
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
243
252
  case 403:
244
253
  throw new Pinnacle.ForbiddenError(_response.error.body);
245
254
  case 500:
@@ -3,6 +3,12 @@
3
3
  */
4
4
  import * as Pinnacle from "../../../../index";
5
5
  /**
6
+ * @example
7
+ * {
8
+ * from: "from",
9
+ * to: "to"
10
+ * }
11
+ *
6
12
  * @example
7
13
  * {
8
14
  * from: "from",
@@ -40,4 +46,7 @@ export interface Rcs {
40
46
  cards?: Pinnacle.Card[];
41
47
  /** Optional list of quick reply actions (max 10). */
42
48
  quickReplies?: Pinnacle.Action[];
49
+ fallback?: Pinnacle.RcsFallback;
50
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
51
+ statusCallback?: string;
43
52
  }
@@ -18,4 +18,6 @@ export interface SendMmsRequest {
18
18
  text?: string;
19
19
  /** The URLs of media to include. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported and have a size limit of 5 MB. 500 KB limit for other types. Up to 10 media URLs can be included. */
20
20
  mediaUrls: string[];
21
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
22
+ statusCallback?: string;
21
23
  }
@@ -16,4 +16,6 @@ export interface SendSmsRequest {
16
16
  from: string;
17
17
  /** The SMS message content (max 1600 characters). */
18
18
  text: string;
19
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
20
+ statusCallback?: string;
19
21
  }
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface RcsFallback {
5
+ /** The sender's phone number in E.164 format. Must be owned by the user. */
6
+ from?: string;
7
+ /** The fallback message content (max 1600 characters). One of 'text' or 'mediaUrls' must be provided. */
8
+ text?: string;
9
+ /** The URLs of media to include. One of 'text' or 'mediaUrls' must be provided. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported and have a size limit of 5 MB. 500 KB limit for other types. Up to 10 media URLs can be included. */
10
+ mediaUrls?: string[];
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,3 +1,4 @@
1
+ export * from "./RcsFallback";
1
2
  export * from "./SendRcsResponse";
2
3
  export * from "./SendSmsResponse";
3
4
  export * from "./SendMmsResponse";
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./RcsFallback"), exports);
17
18
  __exportStar(require("./SendRcsResponse"), exports);
18
19
  __exportStar(require("./SendSmsResponse"), exports);
19
20
  __exportStar(require("./SendMmsResponse"), exports);
@@ -9,11 +9,11 @@ export interface Action {
9
9
  type?: Pinnacle.ActionType;
10
10
  /** Optional payload associated with the action. This payload encodes the respective fields for the action type and is required. For 'openUrl', the payload is the URL to open. For 'call', the payload is the phone number to dial. For 'trigger', the payload is the predefined payload to send to the webhook. */
11
11
  payload?: string;
12
- /** Optional metadata. This is sent alongside the payload to the webhook. */
12
+ /** Optional metadata. Only used for type 'trigger' ignored for other action types. When the user presses the action, the metadata is sent to the webhook alongside the payload. */
13
13
  metadata?: string;
14
- /** Start time for events. Required for 'scheduleEvent'. */
14
+ /** Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'. Required for 'scheduleEvent'. */
15
15
  eventStartTime?: string;
16
- /** End time for events. Required for 'scheduleEvent'. */
16
+ /** End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'. Required for 'scheduleEvent'. */
17
17
  eventEndTime?: string;
18
18
  /** Event title. Required for 'scheduleEvent'. */
19
19
  eventTitle?: string;
@@ -0,0 +1,6 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface PaymentRequiredErrorBody {
5
+ errors?: string[];
6
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,7 @@
1
1
  export * from "./BadRequestErrorBody";
2
2
  export * from "./UnauthorizedErrorBody";
3
3
  export * from "./InternalServerErrorBody";
4
+ export * from "./PaymentRequiredErrorBody";
4
5
  export * from "./ForbiddenErrorBody";
5
6
  export * from "./RcsFunctionalities";
6
7
  export * from "./CompanyAdditionalWebsitesItem";
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestErrorBody"), exports);
18
18
  __exportStar(require("./UnauthorizedErrorBody"), exports);
19
19
  __exportStar(require("./InternalServerErrorBody"), exports);
20
+ __exportStar(require("./PaymentRequiredErrorBody"), exports);
20
21
  __exportStar(require("./ForbiddenErrorBody"), exports);
21
22
  __exportStar(require("./RcsFunctionalities"), exports);
22
23
  __exportStar(require("./CompanyAdditionalWebsitesItem"), exports);
package/dist/Client.js CHANGED
@@ -75,7 +75,7 @@ class PinnacleClient {
75
75
  const _response = yield core.fetcher({
76
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "rcs_functionality"),
77
77
  method: "GET",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  queryParameters: _queryParams,
81
81
  requestType: "json",
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index";
5
+ export declare class PaymentRequiredError extends errors.PinnacleError {
6
+ constructor(body?: unknown);
7
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.PaymentRequiredError = void 0;
30
+ const errors = __importStar(require("../../errors/index"));
31
+ class PaymentRequiredError extends errors.PinnacleError {
32
+ constructor(body) {
33
+ super({
34
+ message: "PaymentRequiredError",
35
+ statusCode: 402,
36
+ body: body,
37
+ });
38
+ Object.setPrototypeOf(this, PaymentRequiredError.prototype);
39
+ }
40
+ }
41
+ exports.PaymentRequiredError = PaymentRequiredError;
@@ -1,4 +1,5 @@
1
1
  export * from "./BadRequestError";
2
2
  export * from "./UnauthorizedError";
3
3
  export * from "./InternalServerError";
4
+ export * from "./PaymentRequiredError";
4
5
  export * from "./ForbiddenError";
@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestError"), exports);
18
18
  __exportStar(require("./UnauthorizedError"), exports);
19
19
  __exportStar(require("./InternalServerError"), exports);
20
+ __exportStar(require("./PaymentRequiredError"), exports);
20
21
  __exportStar(require("./ForbiddenError"), exports);
@@ -43,6 +43,7 @@ export declare class Company {
43
43
  *
44
44
  * @throws {@link Pinnacle.BadRequestError}
45
45
  * @throws {@link Pinnacle.UnauthorizedError}
46
+ * @throws {@link Pinnacle.PaymentRequiredError}
46
47
  * @throws {@link Pinnacle.InternalServerError}
47
48
  *
48
49
  * @example
@@ -76,7 +76,7 @@ class Company {
76
76
  const _response = yield core.fetcher({
77
77
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company"),
78
78
  method: "GET",
79
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
80
80
  contentType: "application/json",
81
81
  queryParameters: _queryParams,
82
82
  requestType: "json",
@@ -130,6 +130,7 @@ class Company {
130
130
  *
131
131
  * @throws {@link Pinnacle.BadRequestError}
132
132
  * @throws {@link Pinnacle.UnauthorizedError}
133
+ * @throws {@link Pinnacle.PaymentRequiredError}
133
134
  * @throws {@link Pinnacle.InternalServerError}
134
135
  *
135
136
  * @example
@@ -166,7 +167,7 @@ class Company {
166
167
  const _response = yield core.fetcher({
167
168
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/register"),
168
169
  method: "POST",
169
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
170
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
170
171
  contentType: "application/json",
171
172
  requestType: "json",
172
173
  body: serializers.CompanyRegisterRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -188,6 +189,8 @@ class Company {
188
189
  throw new Pinnacle.BadRequestError(_response.error.body);
189
190
  case 401:
190
191
  throw new Pinnacle.UnauthorizedError(_response.error.body);
192
+ case 402:
193
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
191
194
  case 500:
192
195
  throw new Pinnacle.InternalServerError(_response.error.body);
193
196
  default:
@@ -233,7 +236,7 @@ class Company {
233
236
  const _response = yield core.fetcher({
234
237
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/update"),
235
238
  method: "POST",
236
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
239
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
237
240
  contentType: "application/json",
238
241
  requestType: "json",
239
242
  body: serializers.CompanyUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -31,6 +31,7 @@ export declare class Send {
31
31
  *
32
32
  * @throws {@link Pinnacle.BadRequestError}
33
33
  * @throws {@link Pinnacle.UnauthorizedError}
34
+ * @throws {@link Pinnacle.PaymentRequiredError}
34
35
  * @throws {@link Pinnacle.ForbiddenError}
35
36
  * @throws {@link Pinnacle.InternalServerError}
36
37
  *
@@ -49,6 +50,7 @@ export declare class Send {
49
50
  *
50
51
  * @throws {@link Pinnacle.BadRequestError}
51
52
  * @throws {@link Pinnacle.UnauthorizedError}
53
+ * @throws {@link Pinnacle.PaymentRequiredError}
52
54
  * @throws {@link Pinnacle.ForbiddenError}
53
55
  * @throws {@link Pinnacle.InternalServerError}
54
56
  *
@@ -68,6 +70,7 @@ export declare class Send {
68
70
  *
69
71
  * @throws {@link Pinnacle.BadRequestError}
70
72
  * @throws {@link Pinnacle.UnauthorizedError}
73
+ * @throws {@link Pinnacle.PaymentRequiredError}
71
74
  * @throws {@link Pinnacle.ForbiddenError}
72
75
  * @throws {@link Pinnacle.InternalServerError}
73
76
  *
@@ -59,6 +59,7 @@ class Send {
59
59
  *
60
60
  * @throws {@link Pinnacle.BadRequestError}
61
61
  * @throws {@link Pinnacle.UnauthorizedError}
62
+ * @throws {@link Pinnacle.PaymentRequiredError}
62
63
  * @throws {@link Pinnacle.ForbiddenError}
63
64
  * @throws {@link Pinnacle.InternalServerError}
64
65
  *
@@ -74,7 +75,7 @@ class Send {
74
75
  const _response = yield core.fetcher({
75
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/rcs"),
76
77
  method: "POST",
77
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
79
  contentType: "application/json",
79
80
  requestType: "json",
80
81
  body: serializers.Rcs.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -96,6 +97,8 @@ class Send {
96
97
  throw new Pinnacle.BadRequestError(_response.error.body);
97
98
  case 401:
98
99
  throw new Pinnacle.UnauthorizedError(_response.error.body);
100
+ case 402:
101
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
99
102
  case 403:
100
103
  throw new Pinnacle.ForbiddenError(_response.error.body);
101
104
  case 500:
@@ -130,6 +133,7 @@ class Send {
130
133
  *
131
134
  * @throws {@link Pinnacle.BadRequestError}
132
135
  * @throws {@link Pinnacle.UnauthorizedError}
136
+ * @throws {@link Pinnacle.PaymentRequiredError}
133
137
  * @throws {@link Pinnacle.ForbiddenError}
134
138
  * @throws {@link Pinnacle.InternalServerError}
135
139
  *
@@ -146,7 +150,7 @@ class Send {
146
150
  const _response = yield core.fetcher({
147
151
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/sms"),
148
152
  method: "POST",
149
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
153
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
150
154
  contentType: "application/json",
151
155
  requestType: "json",
152
156
  body: serializers.SendSmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -168,6 +172,8 @@ class Send {
168
172
  throw new Pinnacle.BadRequestError(_response.error.body);
169
173
  case 401:
170
174
  throw new Pinnacle.UnauthorizedError(_response.error.body);
175
+ case 402:
176
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
171
177
  case 403:
172
178
  throw new Pinnacle.ForbiddenError(_response.error.body);
173
179
  case 500:
@@ -202,6 +208,7 @@ class Send {
202
208
  *
203
209
  * @throws {@link Pinnacle.BadRequestError}
204
210
  * @throws {@link Pinnacle.UnauthorizedError}
211
+ * @throws {@link Pinnacle.PaymentRequiredError}
205
212
  * @throws {@link Pinnacle.ForbiddenError}
206
213
  * @throws {@link Pinnacle.InternalServerError}
207
214
  *
@@ -218,7 +225,7 @@ class Send {
218
225
  const _response = yield core.fetcher({
219
226
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/mms"),
220
227
  method: "POST",
221
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.11", "User-Agent": "rcs-js/1.0.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
228
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
222
229
  contentType: "application/json",
223
230
  requestType: "json",
224
231
  body: serializers.SendMmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -240,6 +247,8 @@ class Send {
240
247
  throw new Pinnacle.BadRequestError(_response.error.body);
241
248
  case 401:
242
249
  throw new Pinnacle.UnauthorizedError(_response.error.body);
250
+ case 402:
251
+ throw new Pinnacle.PaymentRequiredError(_response.error.body);
243
252
  case 403:
244
253
  throw new Pinnacle.ForbiddenError(_response.error.body);
245
254
  case 500:
@@ -3,6 +3,12 @@
3
3
  */
4
4
  import * as Pinnacle from "../../../../index";
5
5
  /**
6
+ * @example
7
+ * {
8
+ * from: "from",
9
+ * to: "to"
10
+ * }
11
+ *
6
12
  * @example
7
13
  * {
8
14
  * from: "from",
@@ -40,4 +46,7 @@ export interface Rcs {
40
46
  cards?: Pinnacle.Card[];
41
47
  /** Optional list of quick reply actions (max 10). */
42
48
  quickReplies?: Pinnacle.Action[];
49
+ fallback?: Pinnacle.RcsFallback;
50
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
51
+ statusCallback?: string;
43
52
  }
@@ -18,4 +18,6 @@ export interface SendMmsRequest {
18
18
  text?: string;
19
19
  /** The URLs of media to include. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported and have a size limit of 5 MB. 500 KB limit for other types. Up to 10 media URLs can be included. */
20
20
  mediaUrls: string[];
21
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
22
+ statusCallback?: string;
21
23
  }
@@ -16,4 +16,6 @@ export interface SendSmsRequest {
16
16
  from: string;
17
17
  /** The SMS message content (max 1600 characters). */
18
18
  text: string;
19
+ /** Optional URL to receive a POST request when the message status changes. Read more about status callbacks [here](/api-reference/receive-msg-statuses). */
20
+ statusCallback?: string;
19
21
  }