@wildix/wim-cache-client 1.0.1 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/dist-cjs/WimCache.js +8 -0
  2. package/dist-cjs/WimCacheClient.js +14 -8
  3. package/dist-cjs/commands/DeleteEntitiesFromGeneralCacheCommand.js +12 -32
  4. package/dist-cjs/commands/DeleteIntegrationDataCommand.js +21 -0
  5. package/dist-cjs/commands/GetEntitiesByIdsCommand.js +12 -32
  6. package/dist-cjs/commands/GetIntegrationDataCommand.js +21 -0
  7. package/dist-cjs/commands/PutEntitiesToGeneralCacheCommand.js +12 -32
  8. package/dist-cjs/commands/PutIntegrationDataCommand.js +21 -0
  9. package/dist-cjs/commands/SearchEntitiesByListParamsCommand.js +12 -32
  10. package/dist-cjs/commands/SearchEntitiesByParamsCommand.js +12 -32
  11. package/dist-cjs/commands/SyncCacheCommand.js +12 -32
  12. package/dist-cjs/commands/UpdateEntitiesWeightCommand.js +21 -0
  13. package/dist-cjs/commands/index.js +4 -0
  14. package/dist-cjs/models/models_0.js +16 -3
  15. package/dist-cjs/protocols/Aws_restJson1.js +227 -227
  16. package/dist-cjs/runtimeConfig.browser.js +5 -1
  17. package/dist-cjs/runtimeConfig.js +8 -3
  18. package/dist-cjs/runtimeConfig.shared.js +13 -11
  19. package/dist-cjs/runtimeExtensions.js +2 -10
  20. package/dist-es/WimCache.js +8 -0
  21. package/dist-es/WimCacheClient.js +15 -9
  22. package/dist-es/commands/DeleteEntitiesFromGeneralCacheCommand.js +12 -32
  23. package/dist-es/commands/DeleteIntegrationDataCommand.js +17 -0
  24. package/dist-es/commands/GetEntitiesByIdsCommand.js +12 -32
  25. package/dist-es/commands/GetIntegrationDataCommand.js +17 -0
  26. package/dist-es/commands/PutEntitiesToGeneralCacheCommand.js +12 -32
  27. package/dist-es/commands/PutIntegrationDataCommand.js +17 -0
  28. package/dist-es/commands/SearchEntitiesByListParamsCommand.js +12 -32
  29. package/dist-es/commands/SearchEntitiesByParamsCommand.js +12 -32
  30. package/dist-es/commands/SyncCacheCommand.js +12 -32
  31. package/dist-es/commands/UpdateEntitiesWeightCommand.js +17 -0
  32. package/dist-es/commands/index.js +4 -0
  33. package/dist-es/models/models_0.js +14 -2
  34. package/dist-es/protocols/Aws_restJson1.js +209 -217
  35. package/dist-es/runtimeConfig.browser.js +4 -1
  36. package/dist-es/runtimeConfig.js +7 -3
  37. package/dist-es/runtimeConfig.shared.js +13 -11
  38. package/dist-es/runtimeExtensions.js +2 -10
  39. package/dist-types/WimCache.d.ts +31 -0
  40. package/dist-types/WimCacheClient.d.ts +22 -11
  41. package/dist-types/commands/DeleteEntitiesFromGeneralCacheCommand.d.ts +24 -21
  42. package/dist-types/commands/DeleteIntegrationDataCommand.d.ts +76 -0
  43. package/dist-types/commands/GetEntitiesByIdsCommand.d.ts +27 -21
  44. package/dist-types/commands/GetIntegrationDataCommand.d.ts +84 -0
  45. package/dist-types/commands/PutEntitiesToGeneralCacheCommand.d.ts +24 -21
  46. package/dist-types/commands/PutIntegrationDataCommand.d.ts +78 -0
  47. package/dist-types/commands/SearchEntitiesByListParamsCommand.d.ts +27 -21
  48. package/dist-types/commands/SearchEntitiesByParamsCommand.d.ts +27 -21
  49. package/dist-types/commands/SyncCacheCommand.d.ts +24 -21
  50. package/dist-types/commands/UpdateEntitiesWeightCommand.d.ts +79 -0
  51. package/dist-types/commands/index.d.ts +4 -0
  52. package/dist-types/index.d.ts +2 -0
  53. package/dist-types/models/WimCacheServiceException.d.ts +2 -1
  54. package/dist-types/models/models_0.d.ts +213 -71
  55. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  56. package/dist-types/runtimeConfig.browser.d.ts +12 -5
  57. package/dist-types/runtimeConfig.d.ts +12 -5
  58. package/dist-types/runtimeConfig.native.d.ts +12 -5
  59. package/package.json +41 -35
@@ -1,11 +1,12 @@
1
1
  import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
2
2
  import { SearchEntitiesByListParamsInput, SearchEntitiesByListParamsOutput } from "../models/models_0";
3
3
  import { Command as $Command } from "@smithy/smithy-client";
4
- import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
5
  /**
6
6
  * @public
7
7
  */
8
- export { __MetadataBearer, $Command };
8
+ export type { __MetadataBearer };
9
+ export { $Command };
9
10
  /**
10
11
  * @public
11
12
  *
@@ -20,8 +21,12 @@ export interface SearchEntitiesByListParamsCommandInput extends SearchEntitiesBy
20
21
  */
21
22
  export interface SearchEntitiesByListParamsCommandOutput extends SearchEntitiesByListParamsOutput, __MetadataBearer {
22
23
  }
24
+ declare const SearchEntitiesByListParamsCommand_base: {
25
+ new (input: SearchEntitiesByListParamsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: SearchEntitiesByListParamsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
23
29
  /**
24
- * @public
25
30
  * searches for entities, unlike a GET request, allows you to specify more matching parameters
26
31
  * @example
27
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -66,6 +71,8 @@ export interface SearchEntitiesByListParamsCommandOutput extends SearchEntitiesB
66
71
  * // IsActive: true || false,
67
72
  * // TimeZoneSidKey: "STRING_VALUE",
68
73
  * // Extension: "STRING_VALUE",
74
+ * // PersonMobilePhone: "STRING_VALUE",
75
+ * // PersonOtherPhone: "STRING_VALUE",
69
76
  * // attributes: { // SalesforceAttrubuteField
70
77
  * // url: "STRING_VALUE",
71
78
  * // type: "STRING_VALUE",
@@ -79,6 +86,7 @@ export interface SearchEntitiesByListParamsCommandOutput extends SearchEntitiesB
79
86
  * // "<keys>": "STRING_VALUE",
80
87
  * // },
81
88
  * // },
89
+ * // weight: Number("long"),
82
90
  * // integrationOrder: Number("int"),
83
91
  * // },
84
92
  * // ],
@@ -96,26 +104,24 @@ export interface SearchEntitiesByListParamsCommandOutput extends SearchEntitiesB
96
104
  *
97
105
  * @throws {@link ValidationException} (client fault)
98
106
  *
107
+ * @throws {@link ForbiddenException} (client fault)
108
+ *
99
109
  * @throws {@link WimCacheServiceException}
100
110
  * <p>Base exception class for all service exceptions from WimCache service.</p>
101
111
  *
112
+ *
113
+ * @public
102
114
  */
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;
115
+ export declare class SearchEntitiesByListParamsCommand extends SearchEntitiesByListParamsCommand_base {
116
+ /** @internal type navigation helper, not in runtime. */
117
+ protected static __types: {
118
+ api: {
119
+ input: SearchEntitiesByListParamsInput;
120
+ output: SearchEntitiesByListParamsOutput;
121
+ };
122
+ sdk: {
123
+ input: SearchEntitiesByListParamsCommandInput;
124
+ output: SearchEntitiesByListParamsCommandOutput;
125
+ };
126
+ };
121
127
  }
@@ -1,11 +1,12 @@
1
1
  import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
2
2
  import { SearchEntitiesByParamsInput, SearchEntitiesByParamsOutput } from "../models/models_0";
3
3
  import { Command as $Command } from "@smithy/smithy-client";
4
- import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
5
  /**
6
6
  * @public
7
7
  */
8
- export { __MetadataBearer, $Command };
8
+ export type { __MetadataBearer };
9
+ export { $Command };
9
10
  /**
10
11
  * @public
11
12
  *
@@ -20,8 +21,12 @@ export interface SearchEntitiesByParamsCommandInput extends SearchEntitiesByPara
20
21
  */
21
22
  export interface SearchEntitiesByParamsCommandOutput extends SearchEntitiesByParamsOutput, __MetadataBearer {
22
23
  }
24
+ declare const SearchEntitiesByParamsCommand_base: {
25
+ new (input: SearchEntitiesByParamsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [SearchEntitiesByParamsCommandInput]): import("@smithy/smithy-client").CommandImpl<SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
23
29
  /**
24
- * @public
25
30
  * 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
31
  * @example
27
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -65,6 +70,8 @@ export interface SearchEntitiesByParamsCommandOutput extends SearchEntitiesByPar
65
70
  * // IsActive: true || false,
66
71
  * // TimeZoneSidKey: "STRING_VALUE",
67
72
  * // Extension: "STRING_VALUE",
73
+ * // PersonMobilePhone: "STRING_VALUE",
74
+ * // PersonOtherPhone: "STRING_VALUE",
68
75
  * // attributes: { // SalesforceAttrubuteField
69
76
  * // url: "STRING_VALUE",
70
77
  * // type: "STRING_VALUE",
@@ -78,6 +85,7 @@ export interface SearchEntitiesByParamsCommandOutput extends SearchEntitiesByPar
78
85
  * // "<keys>": "STRING_VALUE",
79
86
  * // },
80
87
  * // },
88
+ * // weight: Number("long"),
81
89
  * // integrationOrder: Number("int"),
82
90
  * // },
83
91
  * // ],
@@ -95,26 +103,24 @@ export interface SearchEntitiesByParamsCommandOutput extends SearchEntitiesByPar
95
103
  *
96
104
  * @throws {@link ValidationException} (client fault)
97
105
  *
106
+ * @throws {@link ForbiddenException} (client fault)
107
+ *
98
108
  * @throws {@link WimCacheServiceException}
99
109
  * <p>Base exception class for all service exceptions from WimCache service.</p>
100
110
  *
111
+ *
112
+ * @public
101
113
  */
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;
114
+ export declare class SearchEntitiesByParamsCommand extends SearchEntitiesByParamsCommand_base {
115
+ /** @internal type navigation helper, not in runtime. */
116
+ protected static __types: {
117
+ api: {
118
+ input: SearchEntitiesByParamsInput;
119
+ output: SearchEntitiesByParamsOutput;
120
+ };
121
+ sdk: {
122
+ input: SearchEntitiesByParamsCommandInput;
123
+ output: SearchEntitiesByParamsCommandOutput;
124
+ };
125
+ };
120
126
  }
@@ -1,11 +1,12 @@
1
1
  import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
2
2
  import { SyncCacheInput, SyncCacheOutput } from "../models/models_0";
3
3
  import { Command as $Command } from "@smithy/smithy-client";
4
- import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
5
  /**
6
6
  * @public
7
7
  */
8
- export { __MetadataBearer, $Command };
8
+ export type { __MetadataBearer };
9
+ export { $Command };
9
10
  /**
10
11
  * @public
11
12
  *
@@ -20,8 +21,12 @@ export interface SyncCacheCommandInput extends SyncCacheInput {
20
21
  */
21
22
  export interface SyncCacheCommandOutput extends SyncCacheOutput, __MetadataBearer {
22
23
  }
24
+ declare const SyncCacheCommand_base: {
25
+ new (input: SyncCacheCommandInput): import("@smithy/smithy-client").CommandImpl<SyncCacheCommandInput, SyncCacheCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: SyncCacheCommandInput): import("@smithy/smithy-client").CommandImpl<SyncCacheCommandInput, SyncCacheCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
23
29
  /**
24
- * @public
25
30
  * Allows to run target integration synchronization
26
31
  * @example
27
32
  * Use a bare-bones client and the command you need to make an API call.
@@ -48,26 +53,24 @@ export interface SyncCacheCommandOutput extends SyncCacheOutput, __MetadataBeare
48
53
  *
49
54
  * @throws {@link ValidationException} (client fault)
50
55
  *
56
+ * @throws {@link ForbiddenException} (client fault)
57
+ *
51
58
  * @throws {@link WimCacheServiceException}
52
59
  * <p>Base exception class for all service exceptions from WimCache service.</p>
53
60
  *
61
+ *
62
+ * @public
54
63
  */
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;
64
+ export declare class SyncCacheCommand extends SyncCacheCommand_base {
65
+ /** @internal type navigation helper, not in runtime. */
66
+ protected static __types: {
67
+ api: {
68
+ input: SyncCacheInput;
69
+ output: SyncCacheOutput;
70
+ };
71
+ sdk: {
72
+ input: SyncCacheCommandInput;
73
+ output: SyncCacheCommandOutput;
74
+ };
75
+ };
73
76
  }
@@ -0,0 +1,79 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, WimCacheClientResolvedConfig } from "../WimCacheClient";
2
+ import { UpdateEntitiesWeightInput, UpdateEntitiesWeightOutput } 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 UpdateEntitiesWeightCommand}.
14
+ */
15
+ export interface UpdateEntitiesWeightCommandInput extends UpdateEntitiesWeightInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateEntitiesWeightCommand}.
21
+ */
22
+ export interface UpdateEntitiesWeightCommandOutput extends UpdateEntitiesWeightOutput, __MetadataBearer {
23
+ }
24
+ declare const UpdateEntitiesWeightCommand_base: {
25
+ new (input: UpdateEntitiesWeightCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEntitiesWeightCommandInput, UpdateEntitiesWeightCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateEntitiesWeightCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEntitiesWeightCommandInput, UpdateEntitiesWeightCommandOutput, WimCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Allows for batch updating the weight property of multiple entities
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { WimCacheClient, UpdateEntitiesWeightCommand } from "@wildix/wim-cache-client"; // ES Modules import
35
+ * // const { WimCacheClient, UpdateEntitiesWeightCommand } = require("@wildix/wim-cache-client"); // CommonJS import
36
+ * const client = new WimCacheClient(config);
37
+ * const input = { // UpdateEntitiesWeightInput
38
+ * organizationId: "STRING_VALUE", // required
39
+ * entityIds: [ // EntityIds // required
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * };
43
+ * const command = new UpdateEntitiesWeightCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // UpdateEntitiesWeightOutput
46
+ * // success: true || false, // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param UpdateEntitiesWeightCommandInput - {@link UpdateEntitiesWeightCommandInput}
52
+ * @returns {@link UpdateEntitiesWeightCommandOutput}
53
+ * @see {@link UpdateEntitiesWeightCommandInput} for command's `input` shape.
54
+ * @see {@link UpdateEntitiesWeightCommandOutput} for command's `response` shape.
55
+ * @see {@link WimCacheClientResolvedConfig | config} for WimCacheClient's `config` shape.
56
+ *
57
+ * @throws {@link ValidationException} (client fault)
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link WimCacheServiceException}
62
+ * <p>Base exception class for all service exceptions from WimCache service.</p>
63
+ *
64
+ *
65
+ * @public
66
+ */
67
+ export declare class UpdateEntitiesWeightCommand extends UpdateEntitiesWeightCommand_base {
68
+ /** @internal type navigation helper, not in runtime. */
69
+ protected static __types: {
70
+ api: {
71
+ input: UpdateEntitiesWeightInput;
72
+ output: UpdateEntitiesWeightOutput;
73
+ };
74
+ sdk: {
75
+ input: UpdateEntitiesWeightCommandInput;
76
+ output: UpdateEntitiesWeightCommandOutput;
77
+ };
78
+ };
79
+ }
@@ -1,6 +1,10 @@
1
1
  export * from "./DeleteEntitiesFromGeneralCacheCommand";
2
+ export * from "./DeleteIntegrationDataCommand";
2
3
  export * from "./GetEntitiesByIdsCommand";
4
+ export * from "./GetIntegrationDataCommand";
3
5
  export * from "./PutEntitiesToGeneralCacheCommand";
6
+ export * from "./PutIntegrationDataCommand";
4
7
  export * from "./SearchEntitiesByListParamsCommand";
5
8
  export * from "./SearchEntitiesByParamsCommand";
6
9
  export * from "./SyncCacheCommand";
10
+ export * from "./UpdateEntitiesWeightCommand";
@@ -1,5 +1,7 @@
1
1
  export * from "./WimCacheClient";
2
2
  export * from "./WimCache";
3
+ export type { RuntimeExtension } from "./runtimeExtensions";
4
+ export type { WimCacheExtensionConfiguration } from "./extensionConfiguration";
3
5
  export * from "./commands";
4
6
  export * from "./models";
5
7
  export { WimCacheServiceException } from "./models/WimCacheServiceException";
@@ -1,5 +1,6 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
2
- export { __ServiceException, __ServiceExceptionOptions };
2
+ export type { __ServiceExceptionOptions };
3
+ export { __ServiceException };
3
4
  /**
4
5
  * @public
5
6
  *