@wildix/xbees-kite-client 1.0.1
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/Kite.js +25 -0
- package/dist-cjs/KiteClient.js +37 -0
- package/dist-cjs/commands/CreateWidgetCommand.js +21 -0
- package/dist-cjs/commands/DeleteWidgetCommand.js +21 -0
- package/dist-cjs/commands/GetConfigCommand.js +21 -0
- package/dist-cjs/commands/GetWidgetCommand.js +21 -0
- package/dist-cjs/commands/ListServicesCommand.js +21 -0
- package/dist-cjs/commands/ListWidgetsCommand.js +21 -0
- package/dist-cjs/commands/UpdateWidgetCommand.js +21 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/KiteServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +112 -0
- package/dist-cjs/protocols/Aws_restJson1.js +387 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +36 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-cjs/runtimeExtensions.js +19 -0
- package/dist-es/Kite.js +21 -0
- package/dist-es/KiteClient.js +33 -0
- package/dist-es/commands/CreateWidgetCommand.js +17 -0
- package/dist-es/commands/DeleteWidgetCommand.js +17 -0
- package/dist-es/commands/GetConfigCommand.js +17 -0
- package/dist-es/commands/GetWidgetCommand.js +17 -0
- package/dist-es/commands/ListServicesCommand.js +17 -0
- package/dist-es/commands/ListWidgetsCommand.js +17 -0
- package/dist-es/commands/UpdateWidgetCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/KiteServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +104 -0
- package/dist-es/protocols/Aws_restJson1.js +370 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +31 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-es/runtimeExtensions.js +15 -0
- package/dist-types/Kite.d.ts +60 -0
- package/dist-types/KiteClient.d.ts +149 -0
- package/dist-types/commands/CreateWidgetCommand.d.ts +199 -0
- package/dist-types/commands/DeleteWidgetCommand.d.ts +64 -0
- package/dist-types/commands/GetConfigCommand.d.ts +107 -0
- package/dist-types/commands/GetWidgetCommand.d.ts +137 -0
- package/dist-types/commands/ListServicesCommand.d.ts +94 -0
- package/dist-types/commands/ListWidgetsCommand.d.ts +137 -0
- package/dist-types/commands/UpdateWidgetCommand.d.ts +200 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/extensionConfiguration.d.ts +7 -0
- package/dist-types/index.d.ts +7 -0
- package/dist-types/models/KiteServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +617 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +65 -0
- package/dist-types/runtimeConfig.browser.d.ts +28 -0
- package/dist-types/runtimeConfig.d.ts +28 -0
- package/dist-types/runtimeConfig.native.d.ts +27 -0
- package/dist-types/runtimeConfig.shared.d.ts +15 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +78 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { KiteClient } from "./KiteClient";
|
|
2
|
+
import { CreateWidgetCommandInput, CreateWidgetCommandOutput } from "./commands/CreateWidgetCommand";
|
|
3
|
+
import { DeleteWidgetCommandInput, DeleteWidgetCommandOutput } from "./commands/DeleteWidgetCommand";
|
|
4
|
+
import { GetConfigCommandInput, GetConfigCommandOutput } from "./commands/GetConfigCommand";
|
|
5
|
+
import { GetWidgetCommandInput, GetWidgetCommandOutput } from "./commands/GetWidgetCommand";
|
|
6
|
+
import { ListServicesCommandInput, ListServicesCommandOutput } from "./commands/ListServicesCommand";
|
|
7
|
+
import { ListWidgetsCommandInput, ListWidgetsCommandOutput } from "./commands/ListWidgetsCommand";
|
|
8
|
+
import { UpdateWidgetCommandInput, UpdateWidgetCommandOutput } from "./commands/UpdateWidgetCommand";
|
|
9
|
+
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
10
|
+
export interface Kite {
|
|
11
|
+
/**
|
|
12
|
+
* @see {@link CreateWidgetCommand}
|
|
13
|
+
*/
|
|
14
|
+
createWidget(args: CreateWidgetCommandInput, options?: __HttpHandlerOptions): Promise<CreateWidgetCommandOutput>;
|
|
15
|
+
createWidget(args: CreateWidgetCommandInput, cb: (err: any, data?: CreateWidgetCommandOutput) => void): void;
|
|
16
|
+
createWidget(args: CreateWidgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWidgetCommandOutput) => void): void;
|
|
17
|
+
/**
|
|
18
|
+
* @see {@link DeleteWidgetCommand}
|
|
19
|
+
*/
|
|
20
|
+
deleteWidget(args: DeleteWidgetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWidgetCommandOutput>;
|
|
21
|
+
deleteWidget(args: DeleteWidgetCommandInput, cb: (err: any, data?: DeleteWidgetCommandOutput) => void): void;
|
|
22
|
+
deleteWidget(args: DeleteWidgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWidgetCommandOutput) => void): void;
|
|
23
|
+
/**
|
|
24
|
+
* @see {@link GetConfigCommand}
|
|
25
|
+
*/
|
|
26
|
+
getConfig(args: GetConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetConfigCommandOutput>;
|
|
27
|
+
getConfig(args: GetConfigCommandInput, cb: (err: any, data?: GetConfigCommandOutput) => void): void;
|
|
28
|
+
getConfig(args: GetConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConfigCommandOutput) => void): void;
|
|
29
|
+
/**
|
|
30
|
+
* @see {@link GetWidgetCommand}
|
|
31
|
+
*/
|
|
32
|
+
getWidget(args: GetWidgetCommandInput, options?: __HttpHandlerOptions): Promise<GetWidgetCommandOutput>;
|
|
33
|
+
getWidget(args: GetWidgetCommandInput, cb: (err: any, data?: GetWidgetCommandOutput) => void): void;
|
|
34
|
+
getWidget(args: GetWidgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWidgetCommandOutput) => void): void;
|
|
35
|
+
/**
|
|
36
|
+
* @see {@link ListServicesCommand}
|
|
37
|
+
*/
|
|
38
|
+
listServices(): Promise<ListServicesCommandOutput>;
|
|
39
|
+
listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise<ListServicesCommandOutput>;
|
|
40
|
+
listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
41
|
+
listServices(args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
42
|
+
/**
|
|
43
|
+
* @see {@link ListWidgetsCommand}
|
|
44
|
+
*/
|
|
45
|
+
listWidgets(): Promise<ListWidgetsCommandOutput>;
|
|
46
|
+
listWidgets(args: ListWidgetsCommandInput, options?: __HttpHandlerOptions): Promise<ListWidgetsCommandOutput>;
|
|
47
|
+
listWidgets(args: ListWidgetsCommandInput, cb: (err: any, data?: ListWidgetsCommandOutput) => void): void;
|
|
48
|
+
listWidgets(args: ListWidgetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWidgetsCommandOutput) => void): void;
|
|
49
|
+
/**
|
|
50
|
+
* @see {@link UpdateWidgetCommand}
|
|
51
|
+
*/
|
|
52
|
+
updateWidget(args: UpdateWidgetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWidgetCommandOutput>;
|
|
53
|
+
updateWidget(args: UpdateWidgetCommandInput, cb: (err: any, data?: UpdateWidgetCommandOutput) => void): void;
|
|
54
|
+
updateWidget(args: UpdateWidgetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWidgetCommandOutput) => void): void;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export declare class Kite extends KiteClient implements Kite {
|
|
60
|
+
}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
import { CreateWidgetCommandInput, CreateWidgetCommandOutput } from "./commands/CreateWidgetCommand";
|
|
2
|
+
import { DeleteWidgetCommandInput, DeleteWidgetCommandOutput } from "./commands/DeleteWidgetCommand";
|
|
3
|
+
import { GetConfigCommandInput, GetConfigCommandOutput } from "./commands/GetConfigCommand";
|
|
4
|
+
import { GetWidgetCommandInput, GetWidgetCommandOutput } from "./commands/GetWidgetCommand";
|
|
5
|
+
import { ListServicesCommandInput, ListServicesCommandOutput } from "./commands/ListServicesCommand";
|
|
6
|
+
import { ListWidgetsCommandInput, ListWidgetsCommandOutput } from "./commands/ListWidgetsCommand";
|
|
7
|
+
import { UpdateWidgetCommandInput, UpdateWidgetCommandOutput } from "./commands/UpdateWidgetCommand";
|
|
8
|
+
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
9
|
+
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
10
|
+
import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
|
|
11
|
+
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
12
|
+
import { Provider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
13
|
+
import { TokenProvider } from '@wildix/smithy-utils';
|
|
14
|
+
export { __Client };
|
|
15
|
+
/**
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export type ServiceInputTypes = CreateWidgetCommandInput | DeleteWidgetCommandInput | GetConfigCommandInput | GetWidgetCommandInput | ListServicesCommandInput | ListWidgetsCommandInput | UpdateWidgetCommandInput;
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export type ServiceOutputTypes = CreateWidgetCommandOutput | DeleteWidgetCommandOutput | GetConfigCommandOutput | GetWidgetCommandOutput | ListServicesCommandOutput | ListWidgetsCommandOutput | UpdateWidgetCommandOutput;
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
|
|
27
|
+
/**
|
|
28
|
+
* The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
|
|
29
|
+
*/
|
|
30
|
+
requestHandler?: __HttpHandlerUserInput;
|
|
31
|
+
/**
|
|
32
|
+
* A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
|
|
33
|
+
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
34
|
+
* @internal
|
|
35
|
+
*/
|
|
36
|
+
sha256?: __ChecksumConstructor | __HashConstructor;
|
|
37
|
+
/**
|
|
38
|
+
* The function that will be used to convert strings into HTTP endpoints.
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
urlParser?: __UrlParser;
|
|
42
|
+
/**
|
|
43
|
+
* A function that can calculate the length of a request body.
|
|
44
|
+
* @internal
|
|
45
|
+
*/
|
|
46
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
47
|
+
/**
|
|
48
|
+
* A function that converts a stream into an array of bytes.
|
|
49
|
+
* @internal
|
|
50
|
+
*/
|
|
51
|
+
streamCollector?: __StreamCollector;
|
|
52
|
+
/**
|
|
53
|
+
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
base64Decoder?: __Decoder;
|
|
57
|
+
/**
|
|
58
|
+
* The function that will be used to convert binary data to a base64-encoded string.
|
|
59
|
+
* @internal
|
|
60
|
+
*/
|
|
61
|
+
base64Encoder?: __Encoder;
|
|
62
|
+
/**
|
|
63
|
+
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
64
|
+
* @internal
|
|
65
|
+
*/
|
|
66
|
+
utf8Decoder?: __Decoder;
|
|
67
|
+
/**
|
|
68
|
+
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
utf8Encoder?: __Encoder;
|
|
72
|
+
/**
|
|
73
|
+
* The runtime environment.
|
|
74
|
+
* @internal
|
|
75
|
+
*/
|
|
76
|
+
runtime?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Disable dynamically changing the endpoint of the client based on the hostPrefix
|
|
79
|
+
* trait of an operation.
|
|
80
|
+
*/
|
|
81
|
+
disableHostPrefix?: boolean;
|
|
82
|
+
/**
|
|
83
|
+
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
87
|
+
/**
|
|
88
|
+
* Value for how many times a request will be made at most in case of retry.
|
|
89
|
+
*/
|
|
90
|
+
maxAttempts?: number | __Provider<number>;
|
|
91
|
+
/**
|
|
92
|
+
* Specifies which retry algorithm to use.
|
|
93
|
+
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
retryMode?: string | __Provider<string>;
|
|
97
|
+
/**
|
|
98
|
+
* Optional logger for logging debug/info/warn/error.
|
|
99
|
+
*/
|
|
100
|
+
logger?: __Logger;
|
|
101
|
+
/**
|
|
102
|
+
* Optional extensions
|
|
103
|
+
*/
|
|
104
|
+
extensions?: RuntimeExtension[];
|
|
105
|
+
/**
|
|
106
|
+
* The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
107
|
+
*/
|
|
108
|
+
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export type KiteClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & UserAgentInputConfig;
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*
|
|
117
|
+
* The configuration interface of KiteClient class constructor that set the region, credentials and other options.
|
|
118
|
+
*/
|
|
119
|
+
export interface KiteClientConfig extends KiteClientConfigType {
|
|
120
|
+
env: 'stage' | 'stable' | 'prod';
|
|
121
|
+
token: TokenProvider;
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export type KiteClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & UserAgentResolvedConfig;
|
|
127
|
+
/**
|
|
128
|
+
* @public
|
|
129
|
+
*
|
|
130
|
+
* The resolved configuration interface of KiteClient class. This is resolved and normalized from the {@link KiteClientConfig | constructor configuration interface}.
|
|
131
|
+
*/
|
|
132
|
+
export interface KiteClientResolvedConfig extends KiteClientResolvedConfigType {
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export declare class KiteClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KiteClientResolvedConfig> {
|
|
138
|
+
/**
|
|
139
|
+
* The resolved configuration of KiteClient class. This is resolved and normalized from the {@link KiteClientConfig | constructor configuration interface}.
|
|
140
|
+
*/
|
|
141
|
+
readonly config: KiteClientResolvedConfig;
|
|
142
|
+
constructor(...[configuration]: __CheckOptionalClientConfig<KiteClientConfig>);
|
|
143
|
+
/**
|
|
144
|
+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
145
|
+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
146
|
+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
147
|
+
*/
|
|
148
|
+
destroy(): void;
|
|
149
|
+
}
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
import { KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KiteClient";
|
|
2
|
+
import { CreateWidgetInput, CreateWidgetOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateWidgetCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateWidgetCommandInput extends CreateWidgetInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateWidgetCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateWidgetCommandOutput extends CreateWidgetOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateWidgetCommand_base: {
|
|
25
|
+
new (input: CreateWidgetCommandInput): import("@smithy/smithy-client").CommandImpl<CreateWidgetCommandInput, CreateWidgetCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateWidgetCommandInput): import("@smithy/smithy-client").CommandImpl<CreateWidgetCommandInput, CreateWidgetCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Creates a new widget.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { KiteClient, CreateWidgetCommand } from "@wildix/xbees-kite-client"; // ES Modules import
|
|
35
|
+
* // const { KiteClient, CreateWidgetCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
|
|
36
|
+
* const client = new KiteClient(config);
|
|
37
|
+
* const input = { // CreateWidgetInput
|
|
38
|
+
* appearance: { // WidgetAppearance
|
|
39
|
+
* pallete: { // WidgetPalleteSettings
|
|
40
|
+
* backgroundColor: "STRING_VALUE",
|
|
41
|
+
* accentColor: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* text: { // WidgetTextSettings
|
|
44
|
+
* button: "STRING_VALUE",
|
|
45
|
+
* title: "STRING_VALUE",
|
|
46
|
+
* topTitle: "STRING_VALUE",
|
|
47
|
+
* topSubtitle: "STRING_VALUE",
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* routes: [ // WidgetRoutesList
|
|
51
|
+
* { // WidgetRoute
|
|
52
|
+
* id: "STRING_VALUE", // required
|
|
53
|
+
* rules: [ // WidgetRouteRulesList // required
|
|
54
|
+
* { // WidgetRouteRule Union: only one key present
|
|
55
|
+
* timeFrame: { // WidgetRouteTimeFrameRule
|
|
56
|
+
* timeZone: "STRING_VALUE", // required
|
|
57
|
+
* day: "EVERY_DAY" || "WEEKDAYS" || "WEEKENDS" || "MONDAY" || "THUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY", // required
|
|
58
|
+
* startMinute: Number("int"), // required
|
|
59
|
+
* endMinute: Number("int"), // required
|
|
60
|
+
* },
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
63
|
+
* target: { // WidgetTarget Union: only one key present
|
|
64
|
+
* service: { // WidgetServiceTarget
|
|
65
|
+
* id: Number("int"), // required
|
|
66
|
+
* uri: "STRING_VALUE", // required
|
|
67
|
+
* },
|
|
68
|
+
* agent: { // WidgetAgentTarget
|
|
69
|
+
* email: "STRING_VALUE", // required
|
|
70
|
+
* },
|
|
71
|
+
* bot: { // WidgetBotTarget
|
|
72
|
+
* id: "STRING_VALUE", // required
|
|
73
|
+
* },
|
|
74
|
+
* },
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* welcomeMessages: [ // WelcomeMessagesList
|
|
78
|
+
* { // WelcomeMessage
|
|
79
|
+
* text: "STRING_VALUE",
|
|
80
|
+
* predefinedReplies: [ // MessagePredefinedRepliesList
|
|
81
|
+
* { // MessagePredefinedReply
|
|
82
|
+
* text: "STRING_VALUE", // required
|
|
83
|
+
* label: "STRING_VALUE",
|
|
84
|
+
* },
|
|
85
|
+
* ],
|
|
86
|
+
* delay: Number("int"),
|
|
87
|
+
* },
|
|
88
|
+
* ],
|
|
89
|
+
* name: "STRING_VALUE", // required
|
|
90
|
+
* target: {// Union: only one key present
|
|
91
|
+
* service: {
|
|
92
|
+
* id: Number("int"), // required
|
|
93
|
+
* uri: "STRING_VALUE", // required
|
|
94
|
+
* },
|
|
95
|
+
* agent: {
|
|
96
|
+
* email: "STRING_VALUE", // required
|
|
97
|
+
* },
|
|
98
|
+
* bot: {
|
|
99
|
+
* id: "STRING_VALUE", // required
|
|
100
|
+
* },
|
|
101
|
+
* },
|
|
102
|
+
* companyId: "STRING_VALUE",
|
|
103
|
+
* };
|
|
104
|
+
* const command = new CreateWidgetCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* // { // CreateWidgetOutput
|
|
107
|
+
* // widget: { // Widget
|
|
108
|
+
* // appearance: { // WidgetAppearance
|
|
109
|
+
* // pallete: { // WidgetPalleteSettings
|
|
110
|
+
* // backgroundColor: "STRING_VALUE",
|
|
111
|
+
* // accentColor: "STRING_VALUE",
|
|
112
|
+
* // },
|
|
113
|
+
* // text: { // WidgetTextSettings
|
|
114
|
+
* // button: "STRING_VALUE",
|
|
115
|
+
* // title: "STRING_VALUE",
|
|
116
|
+
* // topTitle: "STRING_VALUE",
|
|
117
|
+
* // topSubtitle: "STRING_VALUE",
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // routes: [ // WidgetRoutesList
|
|
121
|
+
* // { // WidgetRoute
|
|
122
|
+
* // id: "STRING_VALUE", // required
|
|
123
|
+
* // rules: [ // WidgetRouteRulesList // required
|
|
124
|
+
* // { // WidgetRouteRule Union: only one key present
|
|
125
|
+
* // timeFrame: { // WidgetRouteTimeFrameRule
|
|
126
|
+
* // timeZone: "STRING_VALUE", // required
|
|
127
|
+
* // day: "EVERY_DAY" || "WEEKDAYS" || "WEEKENDS" || "MONDAY" || "THUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY", // required
|
|
128
|
+
* // startMinute: Number("int"), // required
|
|
129
|
+
* // endMinute: Number("int"), // required
|
|
130
|
+
* // },
|
|
131
|
+
* // },
|
|
132
|
+
* // ],
|
|
133
|
+
* // target: { // WidgetTarget Union: only one key present
|
|
134
|
+
* // service: { // WidgetServiceTarget
|
|
135
|
+
* // id: Number("int"), // required
|
|
136
|
+
* // uri: "STRING_VALUE", // required
|
|
137
|
+
* // },
|
|
138
|
+
* // agent: { // WidgetAgentTarget
|
|
139
|
+
* // email: "STRING_VALUE", // required
|
|
140
|
+
* // },
|
|
141
|
+
* // bot: { // WidgetBotTarget
|
|
142
|
+
* // id: "STRING_VALUE", // required
|
|
143
|
+
* // },
|
|
144
|
+
* // },
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // welcomeMessages: [ // WelcomeMessagesList
|
|
148
|
+
* // { // WelcomeMessage
|
|
149
|
+
* // text: "STRING_VALUE",
|
|
150
|
+
* // predefinedReplies: [ // MessagePredefinedRepliesList
|
|
151
|
+
* // { // MessagePredefinedReply
|
|
152
|
+
* // text: "STRING_VALUE", // required
|
|
153
|
+
* // label: "STRING_VALUE",
|
|
154
|
+
* // },
|
|
155
|
+
* // ],
|
|
156
|
+
* // delay: Number("int"),
|
|
157
|
+
* // },
|
|
158
|
+
* // ],
|
|
159
|
+
* // name: "STRING_VALUE", // required
|
|
160
|
+
* // target: {// Union: only one key present
|
|
161
|
+
* // service: {
|
|
162
|
+
* // id: Number("int"), // required
|
|
163
|
+
* // uri: "STRING_VALUE", // required
|
|
164
|
+
* // },
|
|
165
|
+
* // agent: {
|
|
166
|
+
* // email: "STRING_VALUE", // required
|
|
167
|
+
* // },
|
|
168
|
+
* // bot: {
|
|
169
|
+
* // id: "STRING_VALUE", // required
|
|
170
|
+
* // },
|
|
171
|
+
* // },
|
|
172
|
+
* // id: "STRING_VALUE", // required
|
|
173
|
+
* // company: "STRING_VALUE", // required
|
|
174
|
+
* // createdAt: "STRING_VALUE", // required
|
|
175
|
+
* // updatedAt: "STRING_VALUE",
|
|
176
|
+
* // },
|
|
177
|
+
* // };
|
|
178
|
+
*
|
|
179
|
+
* ```
|
|
180
|
+
*
|
|
181
|
+
* @param CreateWidgetCommandInput - {@link CreateWidgetCommandInput}
|
|
182
|
+
* @returns {@link CreateWidgetCommandOutput}
|
|
183
|
+
* @see {@link CreateWidgetCommandInput} for command's `input` shape.
|
|
184
|
+
* @see {@link CreateWidgetCommandOutput} for command's `response` shape.
|
|
185
|
+
* @see {@link KiteClientResolvedConfig | config} for KiteClient's `config` shape.
|
|
186
|
+
*
|
|
187
|
+
* @throws {@link ValidationException} (client fault)
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
190
|
+
*
|
|
191
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
192
|
+
*
|
|
193
|
+
* @throws {@link KiteServiceException}
|
|
194
|
+
* <p>Base exception class for all service exceptions from Kite service.</p>
|
|
195
|
+
*
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
export declare class CreateWidgetCommand extends CreateWidgetCommand_base {
|
|
199
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KiteClient";
|
|
2
|
+
import { DeleteWidgetInput, DeleteWidgetOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteWidgetCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteWidgetCommandInput extends DeleteWidgetInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteWidgetCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteWidgetCommandOutput extends DeleteWidgetOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteWidgetCommand_base: {
|
|
25
|
+
new (input: DeleteWidgetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWidgetCommandInput, DeleteWidgetCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteWidgetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteWidgetCommandInput, DeleteWidgetCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Deletes an existing widget. This operation is idempotent, meaning that if the widget does not exist, the operation will still return a successful response.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { KiteClient, DeleteWidgetCommand } from "@wildix/xbees-kite-client"; // ES Modules import
|
|
35
|
+
* // const { KiteClient, DeleteWidgetCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
|
|
36
|
+
* const client = new KiteClient(config);
|
|
37
|
+
* const input = { // DeleteWidgetInput
|
|
38
|
+
* widgetId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteWidgetCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteWidgetCommandInput - {@link DeleteWidgetCommandInput}
|
|
47
|
+
* @returns {@link DeleteWidgetCommandOutput}
|
|
48
|
+
* @see {@link DeleteWidgetCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteWidgetCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link KiteClientResolvedConfig | config} for KiteClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ValidationException} (client fault)
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link KiteServiceException}
|
|
59
|
+
* <p>Base exception class for all service exceptions from Kite service.</p>
|
|
60
|
+
*
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export declare class DeleteWidgetCommand extends DeleteWidgetCommand_base {
|
|
64
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KiteClient";
|
|
2
|
+
import { GetConfigInput, GetConfigOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConfigCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConfigCommandInput extends GetConfigInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConfigCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConfigCommandOutput extends GetConfigOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetConfigCommand_base: {
|
|
25
|
+
new (input: GetConfigCommandInput): import("@smithy/smithy-client").CommandImpl<GetConfigCommandInput, GetConfigCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetConfigCommandInput): import("@smithy/smithy-client").CommandImpl<GetConfigCommandInput, GetConfigCommandOutput, KiteClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { KiteClient, GetConfigCommand } from "@wildix/xbees-kite-client"; // ES Modules import
|
|
36
|
+
* // const { KiteClient, GetConfigCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
|
|
37
|
+
* const client = new KiteClient(config);
|
|
38
|
+
* const input = { // GetConfigInput
|
|
39
|
+
* targetId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetConfigCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetConfigOutput
|
|
44
|
+
* // config: { // KiteConfig
|
|
45
|
+
* // targetId: "STRING_VALUE", // required
|
|
46
|
+
* // targetRouteId: "STRING_VALUE",
|
|
47
|
+
* // targetVariant: "group" || "direct",
|
|
48
|
+
* // agents: [ // KiteAgentsList
|
|
49
|
+
* // { // KiteAgent
|
|
50
|
+
* // id: "STRING_VALUE", // required
|
|
51
|
+
* // name: "STRING_VALUE",
|
|
52
|
+
* // picture: "STRING_VALUE",
|
|
53
|
+
* // bot: true || false,
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // appearance: { // WidgetAppearance
|
|
57
|
+
* // pallete: { // WidgetPalleteSettings
|
|
58
|
+
* // backgroundColor: "STRING_VALUE",
|
|
59
|
+
* // accentColor: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // text: { // WidgetTextSettings
|
|
62
|
+
* // button: "STRING_VALUE",
|
|
63
|
+
* // title: "STRING_VALUE",
|
|
64
|
+
* // topTitle: "STRING_VALUE",
|
|
65
|
+
* // topSubtitle: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // },
|
|
68
|
+
* // welcomeMessages: [ // WelcomeMessagesList
|
|
69
|
+
* // { // WelcomeMessage
|
|
70
|
+
* // text: "STRING_VALUE",
|
|
71
|
+
* // predefinedReplies: [ // MessagePredefinedRepliesList
|
|
72
|
+
* // { // MessagePredefinedReply
|
|
73
|
+
* // text: "STRING_VALUE", // required
|
|
74
|
+
* // label: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // delay: Number("int"),
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // features: [ // KiteFeaturesList
|
|
81
|
+
* // "scheduling",
|
|
82
|
+
* // ],
|
|
83
|
+
* // },
|
|
84
|
+
* // };
|
|
85
|
+
*
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @param GetConfigCommandInput - {@link GetConfigCommandInput}
|
|
89
|
+
* @returns {@link GetConfigCommandOutput}
|
|
90
|
+
* @see {@link GetConfigCommandInput} for command's `input` shape.
|
|
91
|
+
* @see {@link GetConfigCommandOutput} for command's `response` shape.
|
|
92
|
+
* @see {@link KiteClientResolvedConfig | config} for KiteClient's `config` shape.
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link TargetNotFoundException} (client fault)
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ValidationException} (client fault)
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link KiteServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Kite service.</p>
|
|
104
|
+
*
|
|
105
|
+
*/
|
|
106
|
+
export declare class GetConfigCommand extends GetConfigCommand_base {
|
|
107
|
+
}
|