rcs-js 2.0.3-rc.1 → 2.0.5
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 +18 -1
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/types/RichCardsMessage.d.ts +2 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/types/RichCardsMessage.d.mts +2 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,6 +5,23 @@
|
|
|
5
5
|
|
|
6
6
|
The Pinnacle TypeScript library provides convenient access to the Pinnacle APIs from TypeScript.
|
|
7
7
|
|
|
8
|
+
## Table of Contents
|
|
9
|
+
|
|
10
|
+
- [Installation](#installation)
|
|
11
|
+
- [Usage](#usage)
|
|
12
|
+
- [Request and Response Types](#request-and-response-types)
|
|
13
|
+
- [Exception Handling](#exception-handling)
|
|
14
|
+
- [Advanced](#advanced)
|
|
15
|
+
- [Additional Headers](#additional-headers)
|
|
16
|
+
- [Additional Query String Parameters](#additional-query-string-parameters)
|
|
17
|
+
- [Retries](#retries)
|
|
18
|
+
- [Timeouts](#timeouts)
|
|
19
|
+
- [Aborting Requests](#aborting-requests)
|
|
20
|
+
- [Access Raw Response Data](#access-raw-response-data)
|
|
21
|
+
- [Runtime Compatibility](#runtime-compatibility)
|
|
22
|
+
- [Contributing](#contributing)
|
|
23
|
+
- [Reference](#reference)
|
|
24
|
+
|
|
8
25
|
## Installation
|
|
9
26
|
|
|
10
27
|
```sh
|
|
@@ -29,7 +46,7 @@ await client.brands.autofill({
|
|
|
29
46
|
});
|
|
30
47
|
```
|
|
31
48
|
|
|
32
|
-
## Request
|
|
49
|
+
## Request and Response Types
|
|
33
50
|
|
|
34
51
|
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
|
|
35
52
|
following namespace:
|
package/dist/cjs/Client.js
CHANGED
|
@@ -54,8 +54,8 @@ class PinnacleClient {
|
|
|
54
54
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
55
55
|
"X-Fern-Language": "JavaScript",
|
|
56
56
|
"X-Fern-SDK-Name": "rcs-js",
|
|
57
|
-
"X-Fern-SDK-Version": "2.0.
|
|
58
|
-
"User-Agent": "rcs-js/2.0.
|
|
57
|
+
"X-Fern-SDK-Version": "2.0.5",
|
|
58
|
+
"User-Agent": "rcs-js/2.0.5",
|
|
59
59
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
60
60
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
61
61
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -31,7 +31,7 @@ export declare namespace RichCardsMessage {
|
|
|
31
31
|
interface StandaloneCard {
|
|
32
32
|
/** The orientation of the standalone card. */
|
|
33
33
|
orientation?: StandaloneCard.Orientation;
|
|
34
|
-
/** The alignment of the image in the standalone card. */
|
|
34
|
+
/** The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL. */
|
|
35
35
|
image_alignment?: StandaloneCard.ImageAlignment;
|
|
36
36
|
}
|
|
37
37
|
namespace StandaloneCard {
|
|
@@ -44,7 +44,7 @@ export declare namespace RichCardsMessage {
|
|
|
44
44
|
readonly Vertical: "VERTICAL";
|
|
45
45
|
};
|
|
46
46
|
/**
|
|
47
|
-
* The alignment of the image in the standalone card.
|
|
47
|
+
* The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL.
|
|
48
48
|
*/
|
|
49
49
|
type ImageAlignment = "LEFT" | "RIGHT";
|
|
50
50
|
const ImageAlignment: {
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.0.
|
|
1
|
+
export declare const SDK_VERSION = "2.0.5";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -18,8 +18,8 @@ export class PinnacleClient {
|
|
|
18
18
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
19
19
|
"X-Fern-Language": "JavaScript",
|
|
20
20
|
"X-Fern-SDK-Name": "rcs-js",
|
|
21
|
-
"X-Fern-SDK-Version": "2.0.
|
|
22
|
-
"User-Agent": "rcs-js/2.0.
|
|
21
|
+
"X-Fern-SDK-Version": "2.0.5",
|
|
22
|
+
"User-Agent": "rcs-js/2.0.5",
|
|
23
23
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
24
24
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
25
25
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -31,7 +31,7 @@ export declare namespace RichCardsMessage {
|
|
|
31
31
|
interface StandaloneCard {
|
|
32
32
|
/** The orientation of the standalone card. */
|
|
33
33
|
orientation?: StandaloneCard.Orientation;
|
|
34
|
-
/** The alignment of the image in the standalone card. */
|
|
34
|
+
/** The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL. */
|
|
35
35
|
image_alignment?: StandaloneCard.ImageAlignment;
|
|
36
36
|
}
|
|
37
37
|
namespace StandaloneCard {
|
|
@@ -44,7 +44,7 @@ export declare namespace RichCardsMessage {
|
|
|
44
44
|
readonly Vertical: "VERTICAL";
|
|
45
45
|
};
|
|
46
46
|
/**
|
|
47
|
-
* The alignment of the image in the standalone card.
|
|
47
|
+
* The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL.
|
|
48
48
|
*/
|
|
49
49
|
type ImageAlignment = "LEFT" | "RIGHT";
|
|
50
50
|
const ImageAlignment: {
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.0.
|
|
1
|
+
export declare const SDK_VERSION = "2.0.5";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "2.0.
|
|
1
|
+
export const SDK_VERSION = "2.0.5";
|