@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,120 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { SearchEntitiesByParamsInput, SearchEntitiesByParamsOutput } 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 SearchEntitiesByParamsCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface SearchEntitiesByParamsCommandInput extends SearchEntitiesByParamsInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link SearchEntitiesByParamsCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface SearchEntitiesByParamsCommandOutput extends SearchEntitiesByParamsOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Searches for entities, unlike a POST request allows to specify additional parameters such as 'query', 'from', and 'size'. requires one of the parameters: query or email or phone
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, SearchEntitiesByParamsCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, SearchEntitiesByParamsCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // SearchEntitiesByParamsInput
|
|
33
|
+
* organizationId: "STRING_VALUE",
|
|
34
|
+
* phone: "STRING_VALUE",
|
|
35
|
+
* email: "STRING_VALUE",
|
|
36
|
+
* query: "STRING_VALUE",
|
|
37
|
+
* from: Number("int"),
|
|
38
|
+
* size: Number("int"),
|
|
39
|
+
* };
|
|
40
|
+
* const command = new SearchEntitiesByParamsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // SearchEntitiesByParamsOutput
|
|
43
|
+
* // items: [ // SearchResultList
|
|
44
|
+
* // { // SearchResult
|
|
45
|
+
* // email: "STRING_VALUE",
|
|
46
|
+
* // phone: "STRING_VALUE",
|
|
47
|
+
* // items: [ // EntityList
|
|
48
|
+
* // { // Entity
|
|
49
|
+
* // integrationId: "STRING_VALUE", // required
|
|
50
|
+
* // entityType: "STRING_VALUE", // required
|
|
51
|
+
* // data: { // EntityData
|
|
52
|
+
* // Id: "STRING_VALUE",
|
|
53
|
+
* // Name: "STRING_VALUE",
|
|
54
|
+
* // FirstName: "STRING_VALUE",
|
|
55
|
+
* // LastName: "STRING_VALUE",
|
|
56
|
+
* // Phone: "STRING_VALUE",
|
|
57
|
+
* // Email: "STRING_VALUE",
|
|
58
|
+
* // OwnerId: "STRING_VALUE",
|
|
59
|
+
* // MobilePhone: "STRING_VALUE",
|
|
60
|
+
* // AccountId: "STRING_VALUE",
|
|
61
|
+
* // Company: "STRING_VALUE",
|
|
62
|
+
* // IsConverted: true || false,
|
|
63
|
+
* // LastModifiedDate: "STRING_VALUE",
|
|
64
|
+
* // CompanyName: "STRING_VALUE",
|
|
65
|
+
* // IsActive: true || false,
|
|
66
|
+
* // TimeZoneSidKey: "STRING_VALUE",
|
|
67
|
+
* // Extension: "STRING_VALUE",
|
|
68
|
+
* // attributes: { // SalesforceAttrubuteField
|
|
69
|
+
* // url: "STRING_VALUE",
|
|
70
|
+
* // type: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // CallPhone: "STRING_VALUE",
|
|
73
|
+
* // Archived: true || false,
|
|
74
|
+
* // Domain: "STRING_VALUE",
|
|
75
|
+
* // UpdatedAt: "STRING_VALUE",
|
|
76
|
+
* // Avatar: "STRING_VALUE",
|
|
77
|
+
* // CustomData: { // GeneralDataMap
|
|
78
|
+
* // "<keys>": "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // integrationOrder: Number("int"),
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // };
|
|
87
|
+
*
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
90
|
+
* @param SearchEntitiesByParamsCommandInput - {@link SearchEntitiesByParamsCommandInput}
|
|
91
|
+
* @returns {@link SearchEntitiesByParamsCommandOutput}
|
|
92
|
+
* @see {@link SearchEntitiesByParamsCommandInput} for command's `input` shape.
|
|
93
|
+
* @see {@link SearchEntitiesByParamsCommandOutput} for command's `response` shape.
|
|
94
|
+
* @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ValidationException} (client fault)
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link WimCacheServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from WimCache service.</p>
|
|
100
|
+
*
|
|
101
|
+
*/
|
|
102
|
+
export declare class SearchEntitiesByParamsCommand extends $Command<SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput, WimCacheClientResolvedConfig> {
|
|
103
|
+
readonly input: SearchEntitiesByParamsCommandInput;
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
constructor(input: SearchEntitiesByParamsCommandInput);
|
|
108
|
+
/**
|
|
109
|
+
* @internal
|
|
110
|
+
*/
|
|
111
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput>;
|
|
112
|
+
/**
|
|
113
|
+
* @internal
|
|
114
|
+
*/
|
|
115
|
+
private serialize;
|
|
116
|
+
/**
|
|
117
|
+
* @internal
|
|
118
|
+
*/
|
|
119
|
+
private deserialize;
|
|
120
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
|
|
2
|
+
import { SyncCacheInput, SyncCacheOutput } 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 SyncCacheCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface SyncCacheCommandInput extends SyncCacheInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link SyncCacheCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface SyncCacheCommandOutput extends SyncCacheOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Allows to run target integration synchronization
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { WimCacheClient, SyncCacheCommand } from "@wildix/wim-cache-client"; // ES Modules import
|
|
30
|
+
* // const { WimCacheClient, SyncCacheCommand } = require("@wildix/wim-cache-client"); // CommonJS import
|
|
31
|
+
* const client = new WimCacheClient(config);
|
|
32
|
+
* const input = { // SyncCacheInput
|
|
33
|
+
* organizationId: "STRING_VALUE", // required
|
|
34
|
+
* };
|
|
35
|
+
* const command = new SyncCacheCommand(input);
|
|
36
|
+
* const response = await client.send(command);
|
|
37
|
+
* // { // SyncCacheOutput
|
|
38
|
+
* // success: true || false,
|
|
39
|
+
* // };
|
|
40
|
+
*
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @param SyncCacheCommandInput - {@link SyncCacheCommandInput}
|
|
44
|
+
* @returns {@link SyncCacheCommandOutput}
|
|
45
|
+
* @see {@link SyncCacheCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link SyncCacheCommandOutput} 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 SyncCacheCommand extends $Command<SyncCacheCommandInput, SyncCacheCommandOutput, WimCacheClientResolvedConfig> {
|
|
56
|
+
readonly input: SyncCacheCommandInput;
|
|
57
|
+
/**
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
constructor(input: SyncCacheCommandInput);
|
|
61
|
+
/**
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WimCacheClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SyncCacheCommandInput, SyncCacheCommandOutput>;
|
|
65
|
+
/**
|
|
66
|
+
* @internal
|
|
67
|
+
*/
|
|
68
|
+
private serialize;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
private deserialize;
|
|
73
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * from "./DeleteEntitiesFromGeneralCacheCommand";
|
|
2
|
+
export * from "./GetEntitiesByIdsCommand";
|
|
3
|
+
export * from "./PutEntitiesToGeneralCacheCommand";
|
|
4
|
+
export * from "./SearchEntitiesByListParamsCommand";
|
|
5
|
+
export * from "./SearchEntitiesByParamsCommand";
|
|
6
|
+
export * from "./SyncCacheCommand";
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
|
|
2
|
+
import { DefaultExtensionConfiguration } from "@smithy/types";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface WimCacheExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
|
|
7
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
|
|
2
|
+
export { __ServiceException, __ServiceExceptionOptions };
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*
|
|
6
|
+
* Base exception class for all service exceptions from WimCache service.
|
|
7
|
+
*/
|
|
8
|
+
export declare class WimCacheServiceException extends __ServiceException {
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(options: __ServiceExceptionOptions);
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./models_0";
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
import { WimCacheServiceException as __BaseException } from "./WimCacheServiceException";
|
|
2
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare class ValidationException extends __BaseException {
|
|
7
|
+
readonly name: "ValidationException";
|
|
8
|
+
readonly $fault: "client";
|
|
9
|
+
/**
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface DeleteEntitiesFromGeneralCacheInput {
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* Email for delete
|
|
21
|
+
*/
|
|
22
|
+
email?: string;
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
* Phone for delete
|
|
26
|
+
*/
|
|
27
|
+
phone?: string;
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
* Delete all general cache for the current user
|
|
31
|
+
*/
|
|
32
|
+
clean?: boolean;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export interface DeleteEntitiesFromGeneralCacheOutput {
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
export interface SalesforceAttrubuteField {
|
|
43
|
+
url?: string;
|
|
44
|
+
type?: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export interface EntityData {
|
|
50
|
+
Id?: string;
|
|
51
|
+
Name?: string;
|
|
52
|
+
FirstName?: string;
|
|
53
|
+
LastName?: string;
|
|
54
|
+
Phone?: string;
|
|
55
|
+
Email?: string;
|
|
56
|
+
OwnerId?: string;
|
|
57
|
+
MobilePhone?: string;
|
|
58
|
+
AccountId?: string;
|
|
59
|
+
Company?: string;
|
|
60
|
+
IsConverted?: boolean;
|
|
61
|
+
LastModifiedDate?: string;
|
|
62
|
+
CompanyName?: string;
|
|
63
|
+
IsActive?: boolean;
|
|
64
|
+
TimeZoneSidKey?: string;
|
|
65
|
+
Extension?: string;
|
|
66
|
+
attributes?: SalesforceAttrubuteField;
|
|
67
|
+
CallPhone?: string;
|
|
68
|
+
Archived?: boolean;
|
|
69
|
+
Domain?: string;
|
|
70
|
+
UpdatedAt?: string;
|
|
71
|
+
Avatar?: string;
|
|
72
|
+
CustomData?: Record<string, string>;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export interface Entity {
|
|
78
|
+
integrationId: string;
|
|
79
|
+
entityType: string;
|
|
80
|
+
data: EntityData;
|
|
81
|
+
integrationOrder?: number;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export interface GeneralEntityInputData {
|
|
87
|
+
IntegrationId: string;
|
|
88
|
+
IntegrationOrder: number;
|
|
89
|
+
Name?: string;
|
|
90
|
+
Id?: string;
|
|
91
|
+
Phone?: string;
|
|
92
|
+
Email?: string;
|
|
93
|
+
OwnerId?: string;
|
|
94
|
+
Avatar?: string;
|
|
95
|
+
UpdatedAt?: string;
|
|
96
|
+
CustomData?: Record<string, string>;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export interface GetEntitiesByIdsInput {
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
* Organization identifier
|
|
105
|
+
*/
|
|
106
|
+
organizationId?: string;
|
|
107
|
+
/**
|
|
108
|
+
* @public
|
|
109
|
+
* Unique Entities identifiers
|
|
110
|
+
*/
|
|
111
|
+
entityIds: (string)[];
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export interface GetEntitiesByIdsOutput {
|
|
117
|
+
items?: (Entity)[];
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface PutEntitiesToGeneralCacheInput {
|
|
123
|
+
items?: (GeneralEntityInputData)[];
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* @public
|
|
127
|
+
*/
|
|
128
|
+
export interface PutEntitiesToGeneralCacheOutput {
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export interface SearchPostParams {
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
* Phone for search
|
|
137
|
+
*/
|
|
138
|
+
phone?: string;
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
* Email for search
|
|
142
|
+
*/
|
|
143
|
+
email?: string;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
export interface SearchEntitiesByListParamsInput {
|
|
149
|
+
/**
|
|
150
|
+
* @public
|
|
151
|
+
* Organization identifier
|
|
152
|
+
*/
|
|
153
|
+
organizationId?: string;
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
* Params for search
|
|
157
|
+
*/
|
|
158
|
+
params: (SearchPostParams)[];
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
export interface SearchResult {
|
|
164
|
+
email?: string;
|
|
165
|
+
phone?: string;
|
|
166
|
+
items?: (Entity)[];
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
export interface SearchEntitiesByListParamsOutput {
|
|
172
|
+
items?: (SearchResult)[];
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export interface SearchEntitiesByParamsInput {
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
* Unique organization identifier
|
|
181
|
+
*/
|
|
182
|
+
organizationId?: string;
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
* Phone for search
|
|
186
|
+
*/
|
|
187
|
+
phone?: string;
|
|
188
|
+
/**
|
|
189
|
+
* @public
|
|
190
|
+
* Email for search
|
|
191
|
+
*/
|
|
192
|
+
email?: string;
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
* Query string for search (use only for Backend auto loging integrations)
|
|
196
|
+
*/
|
|
197
|
+
query?: string;
|
|
198
|
+
/**
|
|
199
|
+
* @public
|
|
200
|
+
* Starting document offset. Needs to by non-negative and defaults to 0
|
|
201
|
+
*/
|
|
202
|
+
from?: number;
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
* Defines the number of hits to return. Defaults to 10
|
|
206
|
+
*/
|
|
207
|
+
size?: number;
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
export interface SearchEntitiesByParamsOutput {
|
|
213
|
+
items?: (SearchResult)[];
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
export interface SyncCacheInput {
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* Organization identifier
|
|
222
|
+
*/
|
|
223
|
+
organizationId: string;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export interface SyncCacheOutput {
|
|
229
|
+
success?: boolean;
|
|
230
|
+
}
|
|
@@ -0,0 +1,56 @@
|
|
|
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 { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
|
|
8
|
+
import { SerdeContext as __SerdeContext } from "@smithy/types";
|
|
9
|
+
/**
|
|
10
|
+
* serializeAws_restJson1DeleteEntitiesFromGeneralCacheCommand
|
|
11
|
+
*/
|
|
12
|
+
export declare const se_DeleteEntitiesFromGeneralCacheCommand: (input: DeleteEntitiesFromGeneralCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
13
|
+
/**
|
|
14
|
+
* serializeAws_restJson1GetEntitiesByIdsCommand
|
|
15
|
+
*/
|
|
16
|
+
export declare const se_GetEntitiesByIdsCommand: (input: GetEntitiesByIdsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
17
|
+
/**
|
|
18
|
+
* serializeAws_restJson1PutEntitiesToGeneralCacheCommand
|
|
19
|
+
*/
|
|
20
|
+
export declare const se_PutEntitiesToGeneralCacheCommand: (input: PutEntitiesToGeneralCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
21
|
+
/**
|
|
22
|
+
* serializeAws_restJson1SearchEntitiesByListParamsCommand
|
|
23
|
+
*/
|
|
24
|
+
export declare const se_SearchEntitiesByListParamsCommand: (input: SearchEntitiesByListParamsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
25
|
+
/**
|
|
26
|
+
* serializeAws_restJson1SearchEntitiesByParamsCommand
|
|
27
|
+
*/
|
|
28
|
+
export declare const se_SearchEntitiesByParamsCommand: (input: SearchEntitiesByParamsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
29
|
+
/**
|
|
30
|
+
* serializeAws_restJson1SyncCacheCommand
|
|
31
|
+
*/
|
|
32
|
+
export declare const se_SyncCacheCommand: (input: SyncCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
33
|
+
/**
|
|
34
|
+
* deserializeAws_restJson1DeleteEntitiesFromGeneralCacheCommand
|
|
35
|
+
*/
|
|
36
|
+
export declare const de_DeleteEntitiesFromGeneralCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteEntitiesFromGeneralCacheCommandOutput>;
|
|
37
|
+
/**
|
|
38
|
+
* deserializeAws_restJson1GetEntitiesByIdsCommand
|
|
39
|
+
*/
|
|
40
|
+
export declare const de_GetEntitiesByIdsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetEntitiesByIdsCommandOutput>;
|
|
41
|
+
/**
|
|
42
|
+
* deserializeAws_restJson1PutEntitiesToGeneralCacheCommand
|
|
43
|
+
*/
|
|
44
|
+
export declare const de_PutEntitiesToGeneralCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutEntitiesToGeneralCacheCommandOutput>;
|
|
45
|
+
/**
|
|
46
|
+
* deserializeAws_restJson1SearchEntitiesByListParamsCommand
|
|
47
|
+
*/
|
|
48
|
+
export declare const de_SearchEntitiesByListParamsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchEntitiesByListParamsCommandOutput>;
|
|
49
|
+
/**
|
|
50
|
+
* deserializeAws_restJson1SearchEntitiesByParamsCommand
|
|
51
|
+
*/
|
|
52
|
+
export declare const de_SearchEntitiesByParamsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SearchEntitiesByParamsCommandOutput>;
|
|
53
|
+
/**
|
|
54
|
+
* deserializeAws_restJson1SyncCacheCommand
|
|
55
|
+
*/
|
|
56
|
+
export declare const de_SyncCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SyncCacheCommandOutput>;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { FetchHttpHandler as RequestHandler } from "@smithy/fetch-http-handler";
|
|
2
|
+
import { WimCacheClientConfig } from "./WimCacheClient";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
|
|
7
|
+
runtime: string;
|
|
8
|
+
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
11
|
+
requestHandler: ((import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> | Record<string, unknown> | import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/fetch-http-handler").FetchHttpHandlerOptions) & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
12
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
13
|
+
httpHandlerConfigs(): {};
|
|
14
|
+
}) | RequestHandler;
|
|
15
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
16
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
17
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
18
|
+
apiVersion: string;
|
|
19
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
20
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
21
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
22
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
23
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
24
|
+
disableHostPrefix: boolean;
|
|
25
|
+
logger: import("@smithy/types").Logger;
|
|
26
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
27
|
+
};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { NodeHttpHandler as RequestHandler } from "@smithy/node-http-handler";
|
|
2
|
+
import { WimCacheClientConfig } from "./WimCacheClient";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
|
|
7
|
+
runtime: string;
|
|
8
|
+
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
11
|
+
requestHandler: ((import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> | Record<string, unknown> | import("@smithy/node-http-handler").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions) & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
12
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
13
|
+
httpHandlerConfigs(): {};
|
|
14
|
+
}) | RequestHandler;
|
|
15
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
16
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
17
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
18
|
+
apiVersion: string;
|
|
19
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
20
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
21
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
22
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
23
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
24
|
+
disableHostPrefix: boolean;
|
|
25
|
+
logger: import("@smithy/types").Logger;
|
|
26
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
27
|
+
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { WimCacheClientConfig } from "./WimCacheClient";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
|
|
6
|
+
runtime: string;
|
|
7
|
+
sha256: import("@smithy/types").HashConstructor;
|
|
8
|
+
requestHandler: ((import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> | Record<string, unknown> | import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions) & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
|
|
9
|
+
updateHttpClientConfig(key: never, value: never): void;
|
|
10
|
+
httpHandlerConfigs(): {};
|
|
11
|
+
}) | import("@smithy/fetch-http-handler").FetchHttpHandler;
|
|
12
|
+
apiVersion: string;
|
|
13
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
14
|
+
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
15
|
+
streamCollector: import("@smithy/types").StreamCollector;
|
|
16
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
17
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
18
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
19
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
20
|
+
disableHostPrefix: boolean;
|
|
21
|
+
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
22
|
+
retryMode: string | import("@smithy/types").Provider<string>;
|
|
23
|
+
logger: import("@smithy/types").Logger;
|
|
24
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
25
|
+
defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
|
|
26
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { WimCacheClientConfig } from "./WimCacheClient";
|
|
2
|
+
/**
|
|
3
|
+
* @internal
|
|
4
|
+
*/
|
|
5
|
+
export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
|
|
6
|
+
apiVersion: string;
|
|
7
|
+
base64Decoder: import("@smithy/types").Decoder;
|
|
8
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
9
|
+
disableHostPrefix: boolean;
|
|
10
|
+
extensions: import("./runtimeExtensions").RuntimeExtension[];
|
|
11
|
+
logger: import("@smithy/types").Logger;
|
|
12
|
+
urlParser: import("@smithy/types").UrlParser;
|
|
13
|
+
utf8Decoder: import("@smithy/types").Decoder;
|
|
14
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
15
|
+
};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { WimCacheExtensionConfiguration } from "./extensionConfiguration";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface RuntimeExtension {
|
|
6
|
+
configure(extensionConfiguration: WimCacheExtensionConfiguration): void;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
export interface RuntimeExtensionsConfig {
|
|
12
|
+
extensions: RuntimeExtension[];
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
export declare const resolveRuntimeExtensions: (runtimeConfig: any, extensions: RuntimeExtension[]) => any;
|