@wildix/wim-cache-client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/WimCache.js +23 -0
- package/dist-cjs/WimCacheClient.js +35 -0
- package/dist-cjs/commands/DeleteEntitiesFromGeneralCacheCommand.js +41 -0
- package/dist-cjs/commands/GetEntitiesByIdsCommand.js +41 -0
- package/dist-cjs/commands/PutEntitiesToGeneralCacheCommand.js +41 -0
- package/dist-cjs/commands/SearchEntitiesByListParamsCommand.js +41 -0
- package/dist-cjs/commands/SearchEntitiesByParamsCommand.js +41 -0
- package/dist-cjs/commands/SyncCacheCommand.js +41 -0
- package/dist-cjs/commands/index.js +9 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/WimCacheServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +17 -0
- package/dist-cjs/protocols/Aws_restJson1.js +403 -0
- package/dist-cjs/runtimeConfig.browser.js +28 -0
- package/dist-cjs/runtimeConfig.js +32 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +19 -0
- package/dist-cjs/runtimeExtensions.js +19 -0
- package/dist-es/WimCache.js +19 -0
- package/dist-es/WimCacheClient.js +31 -0
- package/dist-es/commands/DeleteEntitiesFromGeneralCacheCommand.js +37 -0
- package/dist-es/commands/GetEntitiesByIdsCommand.js +37 -0
- package/dist-es/commands/PutEntitiesToGeneralCacheCommand.js +37 -0
- package/dist-es/commands/SearchEntitiesByListParamsCommand.js +37 -0
- package/dist-es/commands/SearchEntitiesByParamsCommand.js +37 -0
- package/dist-es/commands/SyncCacheCommand.js +37 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/WimCacheServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/protocols/Aws_restJson1.js +388 -0
- package/dist-es/runtimeConfig.browser.js +24 -0
- package/dist-es/runtimeConfig.js +28 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +15 -0
- package/dist-es/runtimeExtensions.js +15 -0
- package/dist-types/WimCache.d.ts +51 -0
- package/dist-types/WimCacheClient.d.ts +144 -0
- package/dist-types/commands/DeleteEntitiesFromGeneralCacheCommand.d.ts +73 -0
- package/dist-types/commands/GetEntitiesByIdsCommand.d.ts +112 -0
- package/dist-types/commands/PutEntitiesToGeneralCacheCommand.d.ts +86 -0
- package/dist-types/commands/SearchEntitiesByListParamsCommand.d.ts +121 -0
- package/dist-types/commands/SearchEntitiesByParamsCommand.d.ts +120 -0
- package/dist-types/commands/SyncCacheCommand.d.ts +73 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/extensionConfiguration.d.ts +7 -0
- package/dist-types/index.d.ts +5 -0
- package/dist-types/models/WimCacheServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +230 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +56 -0
- package/dist-types/runtimeConfig.browser.d.ts +27 -0
- package/dist-types/runtimeConfig.d.ts +27 -0
- package/dist-types/runtimeConfig.native.d.ts +26 -0
- package/dist-types/runtimeConfig.shared.d.ts +15 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +77 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig, } from "@smithy/protocol-http";
|
|
2
|
+
import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig, } from "@smithy/smithy-client";
|
|
3
|
+
const asPartial = (t) => t;
|
|
4
|
+
export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
|
|
5
|
+
const extensionConfiguration = {
|
|
6
|
+
...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
|
|
7
|
+
...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
|
|
8
|
+
};
|
|
9
|
+
extensions.forEach(extension => extension.configure(extensionConfiguration));
|
|
10
|
+
return {
|
|
11
|
+
...runtimeConfig,
|
|
12
|
+
...resolveDefaultRuntimeConfig(extensionConfiguration),
|
|
13
|
+
...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
|
|
14
|
+
};
|
|
15
|
+
};
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { WimCacheClient } from "./WimCacheClient";
|
|
2
|
+
import { DeleteEntitiesFromGeneralCacheCommandInput, DeleteEntitiesFromGeneralCacheCommandOutput } from "./commands/DeleteEntitiesFromGeneralCacheCommand";
|
|
3
|
+
import { GetEntitiesByIdsCommandInput, GetEntitiesByIdsCommandOutput } from "./commands/GetEntitiesByIdsCommand";
|
|
4
|
+
import { PutEntitiesToGeneralCacheCommandInput, PutEntitiesToGeneralCacheCommandOutput } from "./commands/PutEntitiesToGeneralCacheCommand";
|
|
5
|
+
import { SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput } from "./commands/SearchEntitiesByListParamsCommand";
|
|
6
|
+
import { SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput } from "./commands/SearchEntitiesByParamsCommand";
|
|
7
|
+
import { SyncCacheCommandInput, SyncCacheCommandOutput } from "./commands/SyncCacheCommand";
|
|
8
|
+
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
9
|
+
export interface WimCache {
|
|
10
|
+
/**
|
|
11
|
+
* @see {@link DeleteEntitiesFromGeneralCacheCommand}
|
|
12
|
+
*/
|
|
13
|
+
deleteEntitiesFromGeneralCache(args: DeleteEntitiesFromGeneralCacheCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEntitiesFromGeneralCacheCommandOutput>;
|
|
14
|
+
deleteEntitiesFromGeneralCache(args: DeleteEntitiesFromGeneralCacheCommandInput, cb: (err: any, data?: DeleteEntitiesFromGeneralCacheCommandOutput) => void): void;
|
|
15
|
+
deleteEntitiesFromGeneralCache(args: DeleteEntitiesFromGeneralCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntitiesFromGeneralCacheCommandOutput) => void): void;
|
|
16
|
+
/**
|
|
17
|
+
* @see {@link GetEntitiesByIdsCommand}
|
|
18
|
+
*/
|
|
19
|
+
getEntitiesByIds(args: GetEntitiesByIdsCommandInput, options?: __HttpHandlerOptions): Promise<GetEntitiesByIdsCommandOutput>;
|
|
20
|
+
getEntitiesByIds(args: GetEntitiesByIdsCommandInput, cb: (err: any, data?: GetEntitiesByIdsCommandOutput) => void): void;
|
|
21
|
+
getEntitiesByIds(args: GetEntitiesByIdsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEntitiesByIdsCommandOutput) => void): void;
|
|
22
|
+
/**
|
|
23
|
+
* @see {@link PutEntitiesToGeneralCacheCommand}
|
|
24
|
+
*/
|
|
25
|
+
putEntitiesToGeneralCache(args: PutEntitiesToGeneralCacheCommandInput, options?: __HttpHandlerOptions): Promise<PutEntitiesToGeneralCacheCommandOutput>;
|
|
26
|
+
putEntitiesToGeneralCache(args: PutEntitiesToGeneralCacheCommandInput, cb: (err: any, data?: PutEntitiesToGeneralCacheCommandOutput) => void): void;
|
|
27
|
+
putEntitiesToGeneralCache(args: PutEntitiesToGeneralCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEntitiesToGeneralCacheCommandOutput) => void): void;
|
|
28
|
+
/**
|
|
29
|
+
* @see {@link SearchEntitiesByListParamsCommand}
|
|
30
|
+
*/
|
|
31
|
+
searchEntitiesByListParams(args: SearchEntitiesByListParamsCommandInput, options?: __HttpHandlerOptions): Promise<SearchEntitiesByListParamsCommandOutput>;
|
|
32
|
+
searchEntitiesByListParams(args: SearchEntitiesByListParamsCommandInput, cb: (err: any, data?: SearchEntitiesByListParamsCommandOutput) => void): void;
|
|
33
|
+
searchEntitiesByListParams(args: SearchEntitiesByListParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchEntitiesByListParamsCommandOutput) => void): void;
|
|
34
|
+
/**
|
|
35
|
+
* @see {@link SearchEntitiesByParamsCommand}
|
|
36
|
+
*/
|
|
37
|
+
searchEntitiesByParams(args: SearchEntitiesByParamsCommandInput, options?: __HttpHandlerOptions): Promise<SearchEntitiesByParamsCommandOutput>;
|
|
38
|
+
searchEntitiesByParams(args: SearchEntitiesByParamsCommandInput, cb: (err: any, data?: SearchEntitiesByParamsCommandOutput) => void): void;
|
|
39
|
+
searchEntitiesByParams(args: SearchEntitiesByParamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchEntitiesByParamsCommandOutput) => void): void;
|
|
40
|
+
/**
|
|
41
|
+
* @see {@link SyncCacheCommand}
|
|
42
|
+
*/
|
|
43
|
+
syncCache(args: SyncCacheCommandInput, options?: __HttpHandlerOptions): Promise<SyncCacheCommandOutput>;
|
|
44
|
+
syncCache(args: SyncCacheCommandInput, cb: (err: any, data?: SyncCacheCommandOutput) => void): void;
|
|
45
|
+
syncCache(args: SyncCacheCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SyncCacheCommandOutput) => void): void;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
export declare class WimCache extends WimCacheClient implements WimCache {
|
|
51
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { DeleteEntitiesFromGeneralCacheCommandInput, DeleteEntitiesFromGeneralCacheCommandOutput } from "./commands/DeleteEntitiesFromGeneralCacheCommand";
|
|
2
|
+
import { GetEntitiesByIdsCommandInput, GetEntitiesByIdsCommandOutput } from "./commands/GetEntitiesByIdsCommand";
|
|
3
|
+
import { PutEntitiesToGeneralCacheCommandInput, PutEntitiesToGeneralCacheCommandOutput } from "./commands/PutEntitiesToGeneralCacheCommand";
|
|
4
|
+
import { SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput } from "./commands/SearchEntitiesByListParamsCommand";
|
|
5
|
+
import { SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput } from "./commands/SearchEntitiesByParamsCommand";
|
|
6
|
+
import { SyncCacheCommandInput, SyncCacheCommandOutput } from "./commands/SyncCacheCommand";
|
|
7
|
+
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
8
|
+
import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
|
|
9
|
+
import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
|
|
10
|
+
import { 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 } from "@smithy/types";
|
|
11
|
+
import { TokenProvider } from "@wildix/smithy-utils";
|
|
12
|
+
export { __Client };
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export type ServiceInputTypes = DeleteEntitiesFromGeneralCacheCommandInput | GetEntitiesByIdsCommandInput | PutEntitiesToGeneralCacheCommandInput | SearchEntitiesByListParamsCommandInput | SearchEntitiesByParamsCommandInput | SyncCacheCommandInput;
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export type ServiceOutputTypes = DeleteEntitiesFromGeneralCacheCommandOutput | GetEntitiesByIdsCommandOutput | PutEntitiesToGeneralCacheCommandOutput | SearchEntitiesByListParamsCommandOutput | SearchEntitiesByParamsCommandOutput | SyncCacheCommandOutput;
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
25
|
+
/**
|
|
26
|
+
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
27
|
+
*/
|
|
28
|
+
requestHandler?: __HttpHandler;
|
|
29
|
+
/**
|
|
30
|
+
* A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
|
|
31
|
+
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
sha256?: __ChecksumConstructor | __HashConstructor;
|
|
35
|
+
/**
|
|
36
|
+
* The function that will be used to convert strings into HTTP endpoints.
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
urlParser?: __UrlParser;
|
|
40
|
+
/**
|
|
41
|
+
* A function that can calculate the length of a request body.
|
|
42
|
+
* @internal
|
|
43
|
+
*/
|
|
44
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
45
|
+
/**
|
|
46
|
+
* A function that converts a stream into an array of bytes.
|
|
47
|
+
* @internal
|
|
48
|
+
*/
|
|
49
|
+
streamCollector?: __StreamCollector;
|
|
50
|
+
/**
|
|
51
|
+
* The function that will be used to convert a base64-encoded string to a byte array.
|
|
52
|
+
* @internal
|
|
53
|
+
*/
|
|
54
|
+
base64Decoder?: __Decoder;
|
|
55
|
+
/**
|
|
56
|
+
* The function that will be used to convert binary data to a base64-encoded string.
|
|
57
|
+
* @internal
|
|
58
|
+
*/
|
|
59
|
+
base64Encoder?: __Encoder;
|
|
60
|
+
/**
|
|
61
|
+
* The function that will be used to convert a UTF8-encoded string to a byte array.
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
|
+
utf8Decoder?: __Decoder;
|
|
65
|
+
/**
|
|
66
|
+
* The function that will be used to convert binary data to a UTF-8 encoded string.
|
|
67
|
+
* @internal
|
|
68
|
+
*/
|
|
69
|
+
utf8Encoder?: __Encoder;
|
|
70
|
+
/**
|
|
71
|
+
* The runtime environment.
|
|
72
|
+
* @internal
|
|
73
|
+
*/
|
|
74
|
+
runtime?: string;
|
|
75
|
+
/**
|
|
76
|
+
* Disable dynamically changing the endpoint of the client based on the hostPrefix
|
|
77
|
+
* trait of an operation.
|
|
78
|
+
*/
|
|
79
|
+
disableHostPrefix?: boolean;
|
|
80
|
+
/**
|
|
81
|
+
* Value for how many times a request will be made at most in case of retry.
|
|
82
|
+
*/
|
|
83
|
+
maxAttempts?: number | __Provider<number>;
|
|
84
|
+
/**
|
|
85
|
+
* Specifies which retry algorithm to use.
|
|
86
|
+
* @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
|
|
87
|
+
*
|
|
88
|
+
*/
|
|
89
|
+
retryMode?: string | __Provider<string>;
|
|
90
|
+
/**
|
|
91
|
+
* Optional logger for logging debug/info/warn/error.
|
|
92
|
+
*/
|
|
93
|
+
logger?: __Logger;
|
|
94
|
+
/**
|
|
95
|
+
* Optional extensions
|
|
96
|
+
*/
|
|
97
|
+
extensions?: RuntimeExtension[];
|
|
98
|
+
/**
|
|
99
|
+
* The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
100
|
+
*/
|
|
101
|
+
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
export type WimCacheClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults;
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
*
|
|
110
|
+
* The configuration interface of WimCacheClient class constructor that set the region, credentials and other options.
|
|
111
|
+
*/
|
|
112
|
+
export interface WimCacheClientConfig extends WimCacheClientConfigType {
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export type WimCacheClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig;
|
|
118
|
+
/**
|
|
119
|
+
* @public
|
|
120
|
+
*
|
|
121
|
+
* The resolved configuration interface of WimCacheClient class. This is resolved and normalized from the {@link WimCacheClientConfig | constructor configuration interface}.
|
|
122
|
+
*/
|
|
123
|
+
export interface WimCacheClientResolvedConfig extends WimCacheClientResolvedConfigType {
|
|
124
|
+
}
|
|
125
|
+
export interface WmpApiClientConfig extends WimCacheClientConfigType {
|
|
126
|
+
env: string;
|
|
127
|
+
token: TokenProvider;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class WimCacheClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig> {
|
|
133
|
+
/**
|
|
134
|
+
* The resolved configuration of WimCacheClient class. This is resolved and normalized from the {@link WimCacheClientConfig | constructor configuration interface}.
|
|
135
|
+
*/
|
|
136
|
+
readonly config: WimCacheClientResolvedConfig;
|
|
137
|
+
constructor(...[configuration]: __CheckOptionalClientConfig<WmpApiClientConfig>);
|
|
138
|
+
/**
|
|
139
|
+
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
|
|
140
|
+
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
|
|
141
|
+
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
|
|
142
|
+
*/
|
|
143
|
+
destroy(): void;
|
|
144
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { DeleteEntitiesFromGeneralCacheInput, DeleteEntitiesFromGeneralCacheOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DeleteEntitiesFromGeneralCacheCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DeleteEntitiesFromGeneralCacheCommandInput extends DeleteEntitiesFromGeneralCacheInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DeleteEntitiesFromGeneralCacheCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteEntitiesFromGeneralCacheCommandOutput extends DeleteEntitiesFromGeneralCacheOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Deleting entities to the general cache, requires one of the parameters: email or phone or clean
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, DeleteEntitiesFromGeneralCacheCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, DeleteEntitiesFromGeneralCacheCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // DeleteEntitiesFromGeneralCacheInput
|
|
33
|
+
* email: "STRING_VALUE",
|
|
34
|
+
* phone: "STRING_VALUE",
|
|
35
|
+
* clean: true || false,
|
|
36
|
+
* };
|
|
37
|
+
* const command = new DeleteEntitiesFromGeneralCacheCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // {};
|
|
40
|
+
*
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @param DeleteEntitiesFromGeneralCacheCommandInput - {@link DeleteEntitiesFromGeneralCacheCommandInput}
|
|
44
|
+
* @returns {@link DeleteEntitiesFromGeneralCacheCommandOutput}
|
|
45
|
+
* @see {@link DeleteEntitiesFromGeneralCacheCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link DeleteEntitiesFromGeneralCacheCommandOutput} for command's `response` shape.
|
|
47
|
+
* @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ValidationException} (client fault)
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link WimCacheServiceException}
|
|
52
|
+
* <p>Base exception class for all service exceptions from WimCache service.</p>
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
export declare class DeleteEntitiesFromGeneralCacheCommand extends $Command<DeleteEntitiesFromGeneralCacheCommandInput, DeleteEntitiesFromGeneralCacheCommandOutput, WimCacheClientResolvedConfig> {
|
|
56
|
+
readonly input: DeleteEntitiesFromGeneralCacheCommandInput;
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
constructor(input: DeleteEntitiesFromGeneralCacheCommandInput);
|
|
61
|
+
/**
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEntitiesFromGeneralCacheCommandInput, DeleteEntitiesFromGeneralCacheCommandOutput>;
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
private serialize;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
private deserialize;
|
|
73
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { GetEntitiesByIdsInput, GetEntitiesByIdsOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link GetEntitiesByIdsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface GetEntitiesByIdsCommandInput extends GetEntitiesByIdsInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link GetEntitiesByIdsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface GetEntitiesByIdsCommandOutput extends GetEntitiesByIdsOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Allows to retrieve entities by id, use only in backend integrations
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, GetEntitiesByIdsCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, GetEntitiesByIdsCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // GetEntitiesByIdsInput
|
|
33
|
+
* organizationId: "STRING_VALUE",
|
|
34
|
+
* entityIds: [ // EntityIds // required
|
|
35
|
+
* "STRING_VALUE",
|
|
36
|
+
* ],
|
|
37
|
+
* };
|
|
38
|
+
* const command = new GetEntitiesByIdsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // GetEntitiesByIdsOutput
|
|
41
|
+
* // items: [ // EntityList
|
|
42
|
+
* // { // Entity
|
|
43
|
+
* // integrationId: "STRING_VALUE", // required
|
|
44
|
+
* // entityType: "STRING_VALUE", // required
|
|
45
|
+
* // data: { // EntityData
|
|
46
|
+
* // Id: "STRING_VALUE",
|
|
47
|
+
* // Name: "STRING_VALUE",
|
|
48
|
+
* // FirstName: "STRING_VALUE",
|
|
49
|
+
* // LastName: "STRING_VALUE",
|
|
50
|
+
* // Phone: "STRING_VALUE",
|
|
51
|
+
* // Email: "STRING_VALUE",
|
|
52
|
+
* // OwnerId: "STRING_VALUE",
|
|
53
|
+
* // MobilePhone: "STRING_VALUE",
|
|
54
|
+
* // AccountId: "STRING_VALUE",
|
|
55
|
+
* // Company: "STRING_VALUE",
|
|
56
|
+
* // IsConverted: true || false,
|
|
57
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
58
|
+
* // CompanyName: "STRING_VALUE",
|
|
59
|
+
* // IsActive: true || false,
|
|
60
|
+
* // TimeZoneSidKey: "STRING_VALUE",
|
|
61
|
+
* // Extension: "STRING_VALUE",
|
|
62
|
+
* // attributes: { // SalesforceAttrubuteField
|
|
63
|
+
* // url: "STRING_VALUE",
|
|
64
|
+
* // type: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // CallPhone: "STRING_VALUE",
|
|
67
|
+
* // Archived: true || false,
|
|
68
|
+
* // Domain: "STRING_VALUE",
|
|
69
|
+
* // UpdatedAt: "STRING_VALUE",
|
|
70
|
+
* // Avatar: "STRING_VALUE",
|
|
71
|
+
* // CustomData: { // GeneralDataMap
|
|
72
|
+
* // "<keys>": "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // integrationOrder: Number("int"),
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param GetEntitiesByIdsCommandInput - {@link GetEntitiesByIdsCommandInput}
|
|
83
|
+
* @returns {@link GetEntitiesByIdsCommandOutput}
|
|
84
|
+
* @see {@link GetEntitiesByIdsCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link GetEntitiesByIdsCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ValidationException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link WimCacheServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from WimCache service.</p>
|
|
92
|
+
*
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetEntitiesByIdsCommand extends $Command<GetEntitiesByIdsCommandInput, GetEntitiesByIdsCommandOutput, WimCacheClientResolvedConfig> {
|
|
95
|
+
readonly input: GetEntitiesByIdsCommandInput;
|
|
96
|
+
/**
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
constructor(input: GetEntitiesByIdsCommandInput);
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEntitiesByIdsCommandInput, GetEntitiesByIdsCommandOutput>;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private serialize;
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
private deserialize;
|
|
112
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { PutEntitiesToGeneralCacheInput, PutEntitiesToGeneralCacheOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link PutEntitiesToGeneralCacheCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface PutEntitiesToGeneralCacheCommandInput extends PutEntitiesToGeneralCacheInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link PutEntitiesToGeneralCacheCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface PutEntitiesToGeneralCacheCommandOutput extends PutEntitiesToGeneralCacheOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Adds entities to the general cache
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, PutEntitiesToGeneralCacheCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, PutEntitiesToGeneralCacheCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // PutEntitiesToGeneralCacheInput
|
|
33
|
+
* items: [ // GeneralEntityInputList
|
|
34
|
+
* { // GeneralEntityInputData
|
|
35
|
+
* IntegrationId: "STRING_VALUE", // required
|
|
36
|
+
* IntegrationOrder: Number("int"), // required
|
|
37
|
+
* Name: "STRING_VALUE",
|
|
38
|
+
* Id: "STRING_VALUE",
|
|
39
|
+
* Phone: "STRING_VALUE",
|
|
40
|
+
* Email: "STRING_VALUE",
|
|
41
|
+
* OwnerId: "STRING_VALUE",
|
|
42
|
+
* Avatar: "STRING_VALUE",
|
|
43
|
+
* UpdatedAt: "STRING_VALUE",
|
|
44
|
+
* CustomData: { // GeneralDataMap
|
|
45
|
+
* "<keys>": "STRING_VALUE",
|
|
46
|
+
* },
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* };
|
|
50
|
+
* const command = new PutEntitiesToGeneralCacheCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // {};
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param PutEntitiesToGeneralCacheCommandInput - {@link PutEntitiesToGeneralCacheCommandInput}
|
|
57
|
+
* @returns {@link PutEntitiesToGeneralCacheCommandOutput}
|
|
58
|
+
* @see {@link PutEntitiesToGeneralCacheCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link PutEntitiesToGeneralCacheCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link WimCacheServiceException}
|
|
65
|
+
* <p>Base exception class for all service exceptions from WimCache service.</p>
|
|
66
|
+
*
|
|
67
|
+
*/
|
|
68
|
+
export declare class PutEntitiesToGeneralCacheCommand extends $Command<PutEntitiesToGeneralCacheCommandInput, PutEntitiesToGeneralCacheCommandOutput, WimCacheClientResolvedConfig> {
|
|
69
|
+
readonly input: PutEntitiesToGeneralCacheCommandInput;
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
constructor(input: PutEntitiesToGeneralCacheCommandInput);
|
|
74
|
+
/**
|
|
75
|
+
* @internal
|
|
76
|
+
*/
|
|
77
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutEntitiesToGeneralCacheCommandInput, PutEntitiesToGeneralCacheCommandOutput>;
|
|
78
|
+
/**
|
|
79
|
+
* @internal
|
|
80
|
+
*/
|
|
81
|
+
private serialize;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
private deserialize;
|
|
86
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { SearchEntitiesByListParamsInput, SearchEntitiesByListParamsOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link SearchEntitiesByListParamsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface SearchEntitiesByListParamsCommandInput extends SearchEntitiesByListParamsInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link SearchEntitiesByListParamsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface SearchEntitiesByListParamsCommandOutput extends SearchEntitiesByListParamsOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* searches for entities, unlike a GET request, allows you to specify more matching parameters
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, SearchEntitiesByListParamsCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, SearchEntitiesByListParamsCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // SearchEntitiesByListParamsInput
|
|
33
|
+
* organizationId: "STRING_VALUE",
|
|
34
|
+
* params: [ // SearchPostParamsList // required
|
|
35
|
+
* { // SearchPostParams
|
|
36
|
+
* phone: "STRING_VALUE",
|
|
37
|
+
* email: "STRING_VALUE",
|
|
38
|
+
* },
|
|
39
|
+
* ],
|
|
40
|
+
* };
|
|
41
|
+
* const command = new SearchEntitiesByListParamsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // SearchEntitiesByListParamsOutput
|
|
44
|
+
* // items: [ // SearchResultList
|
|
45
|
+
* // { // SearchResult
|
|
46
|
+
* // email: "STRING_VALUE",
|
|
47
|
+
* // phone: "STRING_VALUE",
|
|
48
|
+
* // items: [ // EntityList
|
|
49
|
+
* // { // Entity
|
|
50
|
+
* // integrationId: "STRING_VALUE", // required
|
|
51
|
+
* // entityType: "STRING_VALUE", // required
|
|
52
|
+
* // data: { // EntityData
|
|
53
|
+
* // Id: "STRING_VALUE",
|
|
54
|
+
* // Name: "STRING_VALUE",
|
|
55
|
+
* // FirstName: "STRING_VALUE",
|
|
56
|
+
* // LastName: "STRING_VALUE",
|
|
57
|
+
* // Phone: "STRING_VALUE",
|
|
58
|
+
* // Email: "STRING_VALUE",
|
|
59
|
+
* // OwnerId: "STRING_VALUE",
|
|
60
|
+
* // MobilePhone: "STRING_VALUE",
|
|
61
|
+
* // AccountId: "STRING_VALUE",
|
|
62
|
+
* // Company: "STRING_VALUE",
|
|
63
|
+
* // IsConverted: true || false,
|
|
64
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
65
|
+
* // CompanyName: "STRING_VALUE",
|
|
66
|
+
* // IsActive: true || false,
|
|
67
|
+
* // TimeZoneSidKey: "STRING_VALUE",
|
|
68
|
+
* // Extension: "STRING_VALUE",
|
|
69
|
+
* // attributes: { // SalesforceAttrubuteField
|
|
70
|
+
* // url: "STRING_VALUE",
|
|
71
|
+
* // type: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // CallPhone: "STRING_VALUE",
|
|
74
|
+
* // Archived: true || false,
|
|
75
|
+
* // Domain: "STRING_VALUE",
|
|
76
|
+
* // UpdatedAt: "STRING_VALUE",
|
|
77
|
+
* // Avatar: "STRING_VALUE",
|
|
78
|
+
* // CustomData: { // GeneralDataMap
|
|
79
|
+
* // "<keys>": "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // integrationOrder: Number("int"),
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // };
|
|
88
|
+
*
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @param SearchEntitiesByListParamsCommandInput - {@link SearchEntitiesByListParamsCommandInput}
|
|
92
|
+
* @returns {@link SearchEntitiesByListParamsCommandOutput}
|
|
93
|
+
* @see {@link SearchEntitiesByListParamsCommandInput} for command's `input` shape.
|
|
94
|
+
* @see {@link SearchEntitiesByListParamsCommandOutput} for command's `response` shape.
|
|
95
|
+
* @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ValidationException} (client fault)
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link WimCacheServiceException}
|
|
100
|
+
* <p>Base exception class for all service exceptions from WimCache service.</p>
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
export declare class SearchEntitiesByListParamsCommand extends $Command<SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput, WimCacheClientResolvedConfig> {
|
|
104
|
+
readonly input: SearchEntitiesByListParamsCommandInput;
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
constructor(input: SearchEntitiesByListParamsCommandInput);
|
|
109
|
+
/**
|
|
110
|
+
* @internal
|
|
111
|
+
*/
|
|
112
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput>;
|
|
113
|
+
/**
|
|
114
|
+
* @internal
|
|
115
|
+
*/
|
|
116
|
+
private serialize;
|
|
117
|
+
/**
|
|
118
|
+
* @internal
|
|
119
|
+
*/
|
|
120
|
+
private deserialize;
|
|
121
|
+
}
|