@wildix/wim-cache-client 1.0.1 → 1.0.4

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,17 @@
 import { WimCacheServiceException as __BaseException } from "./WimCacheServiceException";
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
+/**
+ * @public
+ */
+export declare class ForbiddenException extends __BaseException {
+    readonly name: "ForbiddenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
+}
 /**
  * @public
  */
@@ -16,60 +28,87 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteEntitiesFromGeneralCacheInput {
     /**
-     * @public
      * Email for delete
+     * @public
      */
-    email?: string;
+    email?: string | undefined;
     /**
-     * @public
      * Phone for delete
+     * @public
      */
-    phone?: string;
+    phone?: string | undefined;
     /**
-     * @public
      * Delete all general cache for the current user
+     * @public
      */
-    clean?: boolean;
+    clean?: boolean | undefined;
 }
 /**
  * @public
  */
 export interface DeleteEntitiesFromGeneralCacheOutput {
 }
+/**
+ * @public
+ */
+export interface DeleteIntegrationDataInput {
+    /**
+     * Unique identifier
+     * @public
+     */
+    id: string;
+    /**
+     * Company identifier
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Integration data type
+     * @public
+     */
+    type?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteIntegrationDataOutput {
+}
 /**
  * @public
  */
 export interface SalesforceAttrubuteField {
-    url?: string;
-    type?: string;
+    url?: string | undefined;
+    type?: string | undefined;
 }
 /**
  * @public
  */
 export interface EntityData {
-    Id?: string;
-    Name?: string;
-    FirstName?: string;
-    LastName?: string;
-    Phone?: string;
-    Email?: string;
-    OwnerId?: string;
-    MobilePhone?: string;
-    AccountId?: string;
-    Company?: string;
-    IsConverted?: boolean;
-    LastModifiedDate?: string;
-    CompanyName?: string;
-    IsActive?: boolean;
-    TimeZoneSidKey?: string;
-    Extension?: string;
-    attributes?: SalesforceAttrubuteField;
-    CallPhone?: string;
-    Archived?: boolean;
-    Domain?: string;
-    UpdatedAt?: string;
-    Avatar?: string;
-    CustomData?: Record<string, string>;
+    Id?: string | undefined;
+    Name?: string | undefined;
+    FirstName?: string | undefined;
+    LastName?: string | undefined;
+    Phone?: string | undefined;
+    Email?: string | undefined;
+    OwnerId?: string | undefined;
+    MobilePhone?: string | undefined;
+    AccountId?: string | undefined;
+    Company?: string | undefined;
+    IsConverted?: boolean | undefined;
+    LastModifiedDate?: string | undefined;
+    CompanyName?: string | undefined;
+    IsActive?: boolean | undefined;
+    TimeZoneSidKey?: string | undefined;
+    Extension?: string | undefined;
+    PersonMobilePhone?: string | undefined;
+    PersonOtherPhone?: string | undefined;
+    attributes?: SalesforceAttrubuteField | undefined;
+    CallPhone?: string | undefined;
+    Archived?: boolean | undefined;
+    Domain?: string | undefined;
+    UpdatedAt?: string | undefined;
+    Avatar?: string | undefined;
+    CustomData?: Record<string, string> | undefined;
 }
 /**
  * @public
@@ -78,7 +117,8 @@ export interface Entity {
     integrationId: string;
     entityType: string;
     data: EntityData;
-    integrationOrder?: number;
+    weight?: number | undefined;
+    integrationOrder?: number | undefined;
 }
 /**
  * @public
@@ -86,27 +126,27 @@ export interface Entity {
 export interface GeneralEntityInputData {
     IntegrationId: string;
     IntegrationOrder: number;
-    Name?: string;
-    Id?: string;
-    Phone?: string;
-    Email?: string;
-    OwnerId?: string;
-    Avatar?: string;
-    UpdatedAt?: string;
-    CustomData?: Record<string, string>;
+    Name?: string | undefined;
+    Id?: string | undefined;
+    Phone?: string | undefined;
+    Email?: string | undefined;
+    OwnerId?: string | undefined;
+    Avatar?: string | undefined;
+    UpdatedAt?: string | undefined;
+    CustomData?: Record<string, string> | undefined;
 }
 /**
  * @public
  */
 export interface GetEntitiesByIdsInput {
     /**
-     * @public
      * Organization identifier
+     * @public
      */
-    organizationId?: string;
+    organizationId?: string | undefined;
     /**
-     * @public
      * Unique Entities identifiers
+     * @public
      */
     entityIds: (string)[];
 }
@@ -114,13 +154,59 @@ export interface GetEntitiesByIdsInput {
  * @public
  */
 export interface GetEntitiesByIdsOutput {
-    items?: (Entity)[];
+    items?: (Entity)[] | undefined;
+}
+/**
+ * @public
+ */
+export interface GetIntegrationDataInput {
+    /**
+     * Unique identifier
+     * @public
+     */
+    id: string;
+    /**
+     * Company identifier should be provided only for S2S authorization
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Data type
+     * @public
+     */
+    type?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface IntegrationDataItem {
+    /**
+     * Integration data type
+     * @public
+     */
+    type: string;
+    /**
+     * Integration data
+     * @public
+     */
+    data: __DocumentType;
+    /**
+     * Integration identifier
+     * @public
+     */
+    integrationId: string;
+}
+/**
+ * @public
+ */
+export interface GetIntegrationDataOutput {
+    items?: (IntegrationDataItem)[] | undefined;
 }
 /**
  * @public
  */
 export interface PutEntitiesToGeneralCacheInput {
-    items?: (GeneralEntityInputData)[];
+    items?: (GeneralEntityInputData)[] | undefined;
 }
 /**
  * @public
@@ -130,30 +216,65 @@ export interface PutEntitiesToGeneralCacheOutput {
 /**
  * @public
  */
-export interface SearchPostParams {
+export interface PutIntegrationDataInput {
     /**
+     * Integration identifier
      * @public
-     * Phone for search
      */
-    phone?: string;
+    integrationId: string;
     /**
+     * Unique identifier that will be used for the data retrieving
      * @public
+     */
+    id: string;
+    /**
+     * Integration data
+     * @public
+     */
+    data: __DocumentType;
+    /**
+     * Integration data type
+     * @public
+     */
+    type: string;
+    /**
+     * Company identifier should be provided only for S2S authorization
+     * @public
+     */
+    companyId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface PutIntegrationDataOutput {
+}
+/**
+ * @public
+ */
+export interface SearchPostParams {
+    /**
+     * Phone for search
+     * @public
+     */
+    phone?: string | undefined;
+    /**
      * Email for search
+     * @public
      */
-    email?: string;
+    email?: string | undefined;
 }
 /**
  * @public
  */
 export interface SearchEntitiesByListParamsInput {
     /**
-     * @public
      * Organization identifier
+     * @public
      */
-    organizationId?: string;
+    organizationId?: string | undefined;
     /**
-     * @public
      * Params for search
+     * @public
      */
     params: (SearchPostParams)[];
 }
@@ -161,64 +282,64 @@ export interface SearchEntitiesByListParamsInput {
  * @public
  */
 export interface SearchResult {
-    email?: string;
-    phone?: string;
-    items?: (Entity)[];
+    email?: string | undefined;
+    phone?: string | undefined;
+    items?: (Entity)[] | undefined;
 }
 /**
  * @public
  */
 export interface SearchEntitiesByListParamsOutput {
-    items?: (SearchResult)[];
+    items?: (SearchResult)[] | undefined;
 }
 /**
  * @public
  */
 export interface SearchEntitiesByParamsInput {
     /**
-     * @public
      * Unique organization identifier
+     * @public
      */
-    organizationId?: string;
+    organizationId?: string | undefined;
     /**
-     * @public
      * Phone for search
+     * @public
      */
-    phone?: string;
+    phone?: string | undefined;
     /**
-     * @public
      * Email for search
+     * @public
      */
-    email?: string;
+    email?: string | undefined;
     /**
-     * @public
      * Query string for search (use only for Backend auto loging integrations)
+     * @public
      */
-    query?: string;
+    query?: string | undefined;
     /**
-     * @public
      * Starting document offset. Needs to by non-negative and defaults to 0
+     * @public
      */
-    from?: number;
+    from?: number | undefined;
     /**
-     * @public
      * Defines the number of hits to return. Defaults to 10
+     * @public
      */
-    size?: number;
+    size?: number | undefined;
 }
 /**
  * @public
  */
 export interface SearchEntitiesByParamsOutput {
-    items?: (SearchResult)[];
+    items?: (SearchResult)[] | undefined;
 }
 /**
  * @public
  */
 export interface SyncCacheInput {
     /**
-     * @public
      * Organization identifier
+     * @public
      */
     organizationId: string;
 }
@@ -226,5 +347,26 @@ export interface SyncCacheInput {
  * @public
  */
 export interface SyncCacheOutput {
-    success?: boolean;
+    success?: boolean | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEntitiesWeightInput {
+    /**
+     * Organization identifier
+     * @public
+     */
+    organizationId: string;
+    /**
+     * Unique Entities identifiers
+     * @public
+     */
+    entityIds: (string)[];
+}
+/**
+ * @public
+ */
+export interface UpdateEntitiesWeightOutput {
+    success: boolean;
 }

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -1,23 +1,39 @@
 import { DeleteEntitiesFromGeneralCacheCommandInput, DeleteEntitiesFromGeneralCacheCommandOutput } from "../commands/DeleteEntitiesFromGeneralCacheCommand";
+import { DeleteIntegrationDataCommandInput, DeleteIntegrationDataCommandOutput } from "../commands/DeleteIntegrationDataCommand";
 import { GetEntitiesByIdsCommandInput, GetEntitiesByIdsCommandOutput } from "../commands/GetEntitiesByIdsCommand";
+import { GetIntegrationDataCommandInput, GetIntegrationDataCommandOutput } from "../commands/GetIntegrationDataCommand";
 import { PutEntitiesToGeneralCacheCommandInput, PutEntitiesToGeneralCacheCommandOutput } from "../commands/PutEntitiesToGeneralCacheCommand";
+import { PutIntegrationDataCommandInput, PutIntegrationDataCommandOutput } from "../commands/PutIntegrationDataCommand";
 import { SearchEntitiesByListParamsCommandInput, SearchEntitiesByListParamsCommandOutput } from "../commands/SearchEntitiesByListParamsCommand";
 import { SearchEntitiesByParamsCommandInput, SearchEntitiesByParamsCommandOutput } from "../commands/SearchEntitiesByParamsCommand";
 import { SyncCacheCommandInput, SyncCacheCommandOutput } from "../commands/SyncCacheCommand";
+import { UpdateEntitiesWeightCommandInput, UpdateEntitiesWeightCommandOutput } from "../commands/UpdateEntitiesWeightCommand";
 import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
 import { SerdeContext as __SerdeContext } from "@smithy/types";
 /**
  * serializeAws_restJson1DeleteEntitiesFromGeneralCacheCommand
  */
 export declare const se_DeleteEntitiesFromGeneralCacheCommand: (input: DeleteEntitiesFromGeneralCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1DeleteIntegrationDataCommand
+ */
+export declare const se_DeleteIntegrationDataCommand: (input: DeleteIntegrationDataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetEntitiesByIdsCommand
  */
 export declare const se_GetEntitiesByIdsCommand: (input: GetEntitiesByIdsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetIntegrationDataCommand
+ */
+export declare const se_GetIntegrationDataCommand: (input: GetIntegrationDataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1PutEntitiesToGeneralCacheCommand
  */
 export declare const se_PutEntitiesToGeneralCacheCommand: (input: PutEntitiesToGeneralCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1PutIntegrationDataCommand
+ */
+export declare const se_PutIntegrationDataCommand: (input: PutIntegrationDataCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1SearchEntitiesByListParamsCommand
  */
@@ -30,18 +46,34 @@ export declare const se_SearchEntitiesByParamsCommand: (input: SearchEntitiesByP
  * serializeAws_restJson1SyncCacheCommand
  */
 export declare const se_SyncCacheCommand: (input: SyncCacheCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1UpdateEntitiesWeightCommand
+ */
+export declare const se_UpdateEntitiesWeightCommand: (input: UpdateEntitiesWeightCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * deserializeAws_restJson1DeleteEntitiesFromGeneralCacheCommand
  */
 export declare const de_DeleteEntitiesFromGeneralCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteEntitiesFromGeneralCacheCommandOutput>;
+/**
+ * deserializeAws_restJson1DeleteIntegrationDataCommand
+ */
+export declare const de_DeleteIntegrationDataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteIntegrationDataCommandOutput>;
 /**
  * deserializeAws_restJson1GetEntitiesByIdsCommand
  */
 export declare const de_GetEntitiesByIdsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetEntitiesByIdsCommandOutput>;
+/**
+ * deserializeAws_restJson1GetIntegrationDataCommand
+ */
+export declare const de_GetIntegrationDataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetIntegrationDataCommandOutput>;
 /**
  * deserializeAws_restJson1PutEntitiesToGeneralCacheCommand
  */
 export declare const de_PutEntitiesToGeneralCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutEntitiesToGeneralCacheCommandOutput>;
+/**
+ * deserializeAws_restJson1PutIntegrationDataCommand
+ */
+export declare const de_PutIntegrationDataCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutIntegrationDataCommandOutput>;
 /**
  * deserializeAws_restJson1SearchEntitiesByListParamsCommand
  */
@@ -54,3 +86,7 @@ export declare const de_SearchEntitiesByParamsCommand: (output: __HttpResponse,
  * deserializeAws_restJson1SyncCacheCommand
  */
 export declare const de_SyncCacheCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SyncCacheCommandOutput>;
+/**
+ * deserializeAws_restJson1UpdateEntitiesWeightCommand
+ */
+export declare const de_UpdateEntitiesWeightCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateEntitiesWeightCommandOutput>;

package/dist-types/runtimeConfig.browser.d.ts

@@ -7,16 +7,20 @@ export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     runtime: string;
     defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
     bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
     maxAttempts: number | import("@smithy/types").Provider<number>;
-    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> & {
-        updateHttpClientConfig(key: never, value: never): void;
-        httpHandlerConfigs(): {};
-    }) | RequestHandler;
+    requestHandler: import("@smithy/protocol-http").HttpHandler<any> | RequestHandler;
     retryMode: string | import("@smithy/types").Provider<string>;
     sha256: import("@smithy/types").HashConstructor;
     streamCollector: import("@smithy/types").StreamCollector;
-    env: string;
+    env?: "stage" | "stable" | "prod" | undefined;
     token: import("@wildix/smithy-utils").TokenProvider;
+    cacheMiddleware?: boolean | undefined;
+    protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
+    protocolSettings?: {
+        [setting: string]: unknown;
+        defaultNamespace?: string | undefined;
+    } | undefined;
     apiVersion: string;
     urlParser: import("@smithy/types").UrlParser;
     base64Decoder: import("@smithy/types").Decoder;
@@ -26,4 +30,7 @@ export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     disableHostPrefix: boolean;
     logger: import("@smithy/types").Logger;
     extensions: import("./runtimeExtensions").RuntimeExtension[];
+    customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
+    userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
+    retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
 };

package/dist-types/runtimeConfig.d.ts

@@ -7,16 +7,21 @@ export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     runtime: string;
     defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
     bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
+    defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
     maxAttempts: number | import("@smithy/types").Provider<number>;
-    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> & {
-        updateHttpClientConfig(key: never, value: never): void;
-        httpHandlerConfigs(): {};
-    }) | RequestHandler;
+    requestHandler: RequestHandler | import("@smithy/protocol-http").HttpHandler<any>;
     retryMode: string | import("@smithy/types").Provider<string>;
     sha256: import("@smithy/types").HashConstructor;
     streamCollector: import("@smithy/types").StreamCollector;
-    env: string;
+    userAgentAppId: string | import("@smithy/types").Provider<string | undefined>;
+    env?: "stage" | "stable" | "prod" | undefined;
     token: import("@wildix/smithy-utils").TokenProvider;
+    cacheMiddleware?: boolean | undefined;
+    protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
+    protocolSettings?: {
+        [setting: string]: unknown;
+        defaultNamespace?: string | undefined;
+    } | undefined;
     apiVersion: string;
     urlParser: import("@smithy/types").UrlParser;
     base64Decoder: import("@smithy/types").Decoder;
@@ -26,4 +31,6 @@ export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     disableHostPrefix: boolean;
     logger: import("@smithy/types").Logger;
     extensions: import("./runtimeExtensions").RuntimeExtension[];
+    customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
+    retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
 };

package/dist-types/runtimeConfig.native.d.ts

@@ -5,12 +5,15 @@ import { WimCacheClientConfig } from "./WimCacheClient";
 export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     runtime: string;
     sha256: import("@smithy/types").HashConstructor;
-    env: string;
+    env?: "stage" | "stable" | "prod" | undefined;
     token: import("@wildix/smithy-utils").TokenProvider;
-    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> & {
-        updateHttpClientConfig(key: never, value: never): void;
-        httpHandlerConfigs(): {};
-    }) | import("@smithy/fetch-http-handler").FetchHttpHandler;
+    requestHandler: import("@smithy/types").NodeHttpHandlerOptions | import("@smithy/types").FetchHttpHandlerOptions | Record<string, unknown> | import("@smithy/protocol-http").HttpHandler<any> | import("@smithy/fetch-http-handler").FetchHttpHandler;
+    cacheMiddleware?: boolean | undefined;
+    protocol?: import("@smithy/types").ClientProtocol<any, any> | import("@smithy/types").$ClientProtocol<any, any> | import("@smithy/types").ClientProtocolCtor<any, any> | import("@smithy/types").$ClientProtocolCtor<any, any> | undefined;
+    protocolSettings?: {
+        [setting: string]: unknown;
+        defaultNamespace?: string | undefined;
+    } | undefined;
     apiVersion: string;
     urlParser: import("@smithy/types").UrlParser;
     bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
@@ -20,9 +23,13 @@ export declare const getRuntimeConfig: (config: WimCacheClientConfig) => {
     utf8Decoder: import("@smithy/types").Decoder;
     utf8Encoder: (input: string | Uint8Array) => string;
     disableHostPrefix: boolean;
+    defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
     maxAttempts: number | import("@smithy/types").Provider<number>;
     retryMode: string | import("@smithy/types").Provider<string>;
     logger: import("@smithy/types").Logger;
     extensions: import("./runtimeExtensions").RuntimeExtension[];
     defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
+    customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
+    userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
+    retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
 };