dist¶

Interfaces¶

ConfiguredHandoffInput¶

Properties¶

idempotencyKey?¶

optional idempotencyKey?: string;

payload?¶

optional payload?: unknown;

query?¶

optional query?: Record<string, ProviderQueryValue>;

GenesysPureConnectClient¶

Properties¶

providerClient¶

providerClient: GenesysPureConnectProviderClient;

Methods¶

createConnection()¶

createConnection(input?): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input?`	`GenesysPureConnectOperationInput`

Returns¶

Promise\<ProviderJsonObject>

createHandoff()¶

createHandoff(input?): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input?`	`ConfiguredHandoffInput`

Returns¶

Promise\<ProviderJsonObject>

readiness()¶

readiness(): Promise<ProviderJsonObject>;

Returns¶

Promise\<ProviderJsonObject>

request()¶

request(input): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input`	`ProviderExtensionRequestInput`

Returns¶

Promise\<ProviderJsonObject>

GenesysPureConnectClientOptions¶

Extended by¶

GenesysPureConnectIntegrationOptions

Properties¶

accessToken?¶

optional accessToken?: string;

apiBaseUrl?¶

optional apiBaseUrl?: string;

apiKey?¶

optional apiKey?: string;

apiKeyHeaderName?¶

optional apiKeyHeaderName?: string;

authorizationHeader?¶

optional authorizationHeader?: string;

baseUrl?¶

optional baseUrl?: string;

defaultHandoffPath?¶

optional defaultHandoffPath?: string;

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

providerClient?¶

optional providerClient?: GenesysPureConnectProviderClient;

readinessPath?¶

optional readinessPath?: string;

retry?¶

optional retry?: number | ProviderRestRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

GenesysPureConnectIntegrationOptions¶

Extends¶

GenesysPureConnectClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

GenesysPureConnectClientOptions.accessToken

apiBaseUrl?¶

optional apiBaseUrl?: string;

Inherited from¶

GenesysPureConnectClientOptions.apiBaseUrl

apiKey?¶

optional apiKey?: string;

Inherited from¶

GenesysPureConnectClientOptions.apiKey

apiKeyHeaderName?¶

optional apiKeyHeaderName?: string;

Inherited from¶

GenesysPureConnectClientOptions.apiKeyHeaderName

authorizationHeader?¶

optional authorizationHeader?: string;

Inherited from¶

GenesysPureConnectClientOptions.authorizationHeader

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

GenesysPureConnectClientOptions.baseUrl

defaultHandoffPath?¶

optional defaultHandoffPath?: string;

Inherited from¶

GenesysPureConnectClientOptions.defaultHandoffPath

fetch?¶

optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`URL` \| `RequestInfo`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Call Signature¶

(input, init?): Promise<Response>;

MDN Reference

Parameters¶

Parameter	Type
`input`	`string` \| `Request` \| `URL`
`init?`	`RequestInit`

Returns¶

Promise\<Response>

Inherited from¶

GenesysPureConnectClientOptions.fetch

genesysPureConnectClient?¶

optional genesysPureConnectClient?: GenesysPureConnectClient;

providerClient?¶

optional providerClient?: GenesysPureConnectProviderClient;

Inherited from¶

GenesysPureConnectClientOptions.providerClient

readinessPath?¶

optional readinessPath?: string;

Inherited from¶

GenesysPureConnectClientOptions.readinessPath

retry?¶

optional retry?: number | ProviderRestRetryOptions;

Inherited from¶

GenesysPureConnectClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

GenesysPureConnectClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

GenesysPureConnectClientOptions.timeoutMs

GenesysPureConnectOperationInput¶

Extended by¶

ProviderExtensionRequestInput

Properties¶

body?¶

optional body?: unknown;

headers?¶

optional headers?: Record<string, string>;

idempotencyKey?¶

optional idempotencyKey?: string;

pathParams?¶

optional pathParams?: Record<string, string | number | boolean>;

query?¶

optional query?: Record<string, ProviderQueryValue>;

GenesysPureConnectProviderClient¶

Methods¶

createConnection()¶

createConnection(input?): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input?`	`GenesysPureConnectOperationInput`

Returns¶

Promise\<ProviderJsonObject>

createHandoff()¶

createHandoff(input): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input`	`ConfiguredHandoffInput`

Returns¶

Promise\<ProviderJsonObject>

readiness()?¶

optional readiness(): Promise<ProviderJsonObject>;

Returns¶

Promise\<ProviderJsonObject>

request()¶

request(input): Promise<ProviderJsonObject>;

Parameters¶

Parameter	Type
`input`	`ProviderExtensionRequestInput`

Returns¶

Promise\<ProviderJsonObject>

ProviderExtensionRequestInput¶

Extends¶

GenesysPureConnectOperationInput

Properties¶

allowMutation?¶

optional allowMutation?: boolean;

body?¶

optional body?: unknown;

Inherited from¶

GenesysPureConnectOperationInput.body

classification?¶

optional classification?: string;

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

GenesysPureConnectOperationInput.headers

hostReviewedPath?¶

optional hostReviewedPath?: boolean;

idempotencyKey?¶

optional idempotencyKey?: string;

Inherited from¶

GenesysPureConnectOperationInput.idempotencyKey

method?¶

optional method?: ProviderHttpMethod;

operationId?¶

optional operationId?: string;

path?¶

optional path?: string;

pathParams?¶

optional pathParams?: Record<string, string | number | boolean>;

Inherited from¶

GenesysPureConnectOperationInput.pathParams

query?¶

optional query?: Record<string, ProviderQueryValue>;

Inherited from¶

GenesysPureConnectOperationInput.query

ProviderRestRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

Type Aliases¶

ProviderJsonObject¶

type ProviderJsonObject = Record<string, unknown>;

Functions¶

createGenesysPureConnectClient()¶

function createGenesysPureConnectClient(options?): GenesysPureConnectClient;

Parameters¶

Parameter	Type
`options?`	`GenesysPureConnectClientOptions`

Returns¶

GenesysPureConnectClient

createGenesysPureConnectIntegration()¶

function createGenesysPureConnectIntegration(options?): DefinedIntegration<{
  capabilities: readonly [{
     capability: "handoff";
     exposesSensitiveData: true;
     providerObjects: readonly [{
        kind: "contactTransfer";
        label: "contactTransfer";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     capability: "create-provider-object";
     exposesSensitiveData: true;
     providerObjects: readonly [{
        kind: "contact";
        label: "contact";
     }];
     requiresCredential: true;
     sideEffect: true;
   }, {
     capability: "read-provider-object";
     exposesSensitiveData: true;
     providerObjects: readonly [{
        kind: "contact";
        label: "contact";
     }];
     requiresCredential: true;
     sideEffect: false;
  }];
  category: "contact-center";
  channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
  coverage: {
     evidence: readonly [{
        label: "PureConnect ICWS connection";
        url: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/connection/index.htm";
      }, {
        label: "PureConnect ICWS interactions";
        url: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/%28sessionId%29/interactions/Interactions.htm";
      }, {
        label: "PureConnect ICWS SDK";
        url: "https://help.genesys.com/pureconnect/mergedprojects/wh_tr/mergedprojects/wh_tr_installation_and_configuration/desktop/interaction_center_web_services_icws_sdk.htm";
      }, {
        label: "NPM ICWS candidate machinepack-ic";
        url: "https://www.npmjs.com/package/machinepack-ic";
     }];
     notes: readonly ["No maintained Genesys PureConnect ICWS npm runtime SDK was verified.", "Official PureConnect ICWS SDK documentation describes a REST API and API documentation rather than a maintained npm runtime client.", "Runtime calls use a typed REST adapter for reviewed endpoints when baseUrl/API credentials are supplied, with GenesysPureConnectProviderClient available as a host-client override.", "Host-configured ICWS session paths require explicit hostReviewedPath=true and a host policy classification before requests are dispatched."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     id: "genesys-pureconnect-icws-base-url";
     label: "PureConnect ICWS base URL";
     required: true;
   }, {
     id: "genesys-pureconnect-session";
     label: "PureConnect ICWS session/authentication";
     required: false;
   }, {
     id: "genesys-pureconnect-routing";
     label: "PureConnect Interaction Web Tools routing configuration";
     required: false;
  }];
  directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
  id: "contact-center.genesys-pureconnect";
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     implementation: {
        adapterKind: "no-official-sdk-rest-adapter";
        allowedOperations: readonly [{
           alias: "genesys-pureconnect.icws.connect";
           checksum: "not-available-html-doc";
           id: "createConnection";
           method: "POST";
           path: "/icws/connection";
           source: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/connection/index.htm";
         }, {
           alias: "genesys-pureconnect.icws.request";
           checksum: "not-applicable-host-configured";
           id: "sessionRequest";
           method: "GET";
           path: "host-configured-icws-session-path";
           requiresHostReviewedPath: true;
           source: "host-configured";
        }];
        implementationStrategy: "provider-rest-adapter";
        providerSdkDecision: {
           checkedAt: "2026-06-25";
           checkedPackages: readonly [{
              package: "genesys-pureconnect";
              reason: "No npm package with this official PureConnect runtime SDK name was found.";
              result: "not-published";
            }, {
              package: "pureconnect";
              reason: "No npm package with this official PureConnect runtime SDK name was found.";
              result: "not-published";
            }, {
              checkedVersion: "0.1.0";
              license: "MIT";
              package: "machinepack-ic";
              reason: "Third-party ICWS wrapper, not an official maintained Genesys PureConnect runtime SDK.";
              result: "third-party-unmaintained-icws-package";
            }, {
              checkedVersion: "255.1.0";
              license: "MIT";
              package: "purecloud-platform-client-v2";
              reason: "Maintained SDK targets Genesys Cloud Platform APIs, not PureConnect ICWS.";
              result: "genesys-cloud-sdk-not-pureconnect-icws";
           }];
           defaultRestPolicy: "fail-closed-icws-rest-adapter-with-typed-provider-client-override";
           result: "no-maintained-official-pureconnect-icws-npm-sdk";
           typedClientOverride: "GenesysPureConnectProviderClient";
        };
        sdkAudit: {
           checkedPackages: readonly [{
              name: "genesys-pureconnect";
              result: "not-published";
            }, {
              name: "pureconnect";
              result: "not-published";
            }, {
              name: "purecloud-platform-client-v2";
              result: "maintained-genesys-cloud-sdk-not-pureconnect-icws";
            }, {
              latest: "0.1.0";
              name: "machinepack-ic";
              publishedAt: "2015-08-11";
              result: "third-party-unmaintained-icws-package";
           }];
           maintainedRuntimeSdk: false;
           registry: "npm";
        };
        sdkDecision: "No maintained Genesys PureConnect ICWS npm runtime SDK was verified; the official ICWS SDK page describes a REST API/docs, so this package provides a typed REST adapter with providerClient override.";
        verifiedAt: "2026-06-25";
     };
     manifestOnlySafe: true;
     providerRestAdapter: {
        adapterKind: "no-official-sdk-rest-adapter";
        providerClientOverride: "GenesysPureConnectProviderClient";
        strategy: "provider-rest-adapter";
     };
     providerSdkDecision: {
        checkedAt: "2026-06-25";
        checkedPackages: readonly [{
           package: "genesys-pureconnect";
           reason: "No npm package with this official PureConnect runtime SDK name was found.";
           result: "not-published";
         }, {
           package: "pureconnect";
           reason: "No npm package with this official PureConnect runtime SDK name was found.";
           result: "not-published";
         }, {
           checkedVersion: "0.1.0";
           license: "MIT";
           package: "machinepack-ic";
           reason: "Third-party ICWS wrapper, not an official maintained Genesys PureConnect runtime SDK.";
           result: "third-party-unmaintained-icws-package";
         }, {
           checkedVersion: "255.1.0";
           license: "MIT";
           package: "purecloud-platform-client-v2";
           reason: "Maintained SDK targets Genesys Cloud Platform APIs, not PureConnect ICWS.";
           result: "genesys-cloud-sdk-not-pureconnect-icws";
        }];
        defaultRestPolicy: "fail-closed-icws-rest-adapter-with-typed-provider-client-override";
        result: "no-maintained-official-pureconnect-icws-npm-sdk";
        typedClientOverride: "GenesysPureConnectProviderClient";
     };
  };
  name: "Genesys PureConnect / ICWS";
  operations: readonly [{
     alias: "contact-center.handoff.request";
     capability: "handoff";
     providerObject: "contactTransfer";
   }, {
     alias: "genesys-pureconnect.icws.connect";
     capability: "create-provider-object";
     extension: true;
     providerObject: "contact";
   }, {
     alias: "genesys-pureconnect.icws.request";
     capability: "read-provider-object";
     extension: true;
     providerObject: "contact";
  }];
  packageName: "@cognidesk/integration-contact-center-genesys-pureconnect";
  provider: "genesys-pureconnect";
  trustLevel: "official";
}, unknown, {
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.connect: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.request: (input) => Promise<ProviderJsonObject>;
}>;

Parameters¶

Parameter	Type
`options?`	`GenesysPureConnectIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: readonly [{ capability: "handoff"; exposesSensitiveData: true; providerObjects: readonly [{ kind: "contactTransfer"; label: "contactTransfer"; }]; requiresCredential: true; sideEffect: true; }, { capability: "create-provider-object"; exposesSensitiveData: true; providerObjects: readonly [{ kind: "contact"; label: "contact"; }]; requiresCredential: true; sideEffect: true; }, { capability: "read-provider-object"; exposesSensitiveData: true; providerObjects: readonly [{ kind: "contact"; label: "contact"; }]; requiresCredential: true; sideEffect: false; }]; category: "contact-center"; channelAudiences: readonly ["customer-facing", "internal-support", "mixed"]; coverage: { evidence: readonly [{ label: "PureConnect ICWS connection"; url: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/connection/index.htm"; }, { label: "PureConnect ICWS interactions"; url: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/%28sessionId%29/interactions/Interactions.htm"; }, { label: "PureConnect ICWS SDK"; url: "https://help.genesys.com/pureconnect/mergedprojects/wh_tr/mergedprojects/wh_tr_installation_and_configuration/desktop/interaction_center_web_services_icws_sdk.htm"; }, { label: "NPM ICWS candidate machinepack-ic"; url: "https://www.npmjs.com/package/machinepack-ic"; }]; notes: readonly ["No maintained Genesys PureConnect ICWS npm runtime SDK was verified.", "Official PureConnect ICWS SDK documentation describes a REST API and API documentation rather than a maintained npm runtime client.", "Runtime calls use a typed REST adapter for reviewed endpoints when baseUrl/API credentials are supplied, with GenesysPureConnectProviderClient available as a host-client override.", "Host-configured ICWS session paths require explicit hostReviewedPath=true and a host policy classification before requests are dispatched."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ id: "genesys-pureconnect-icws-base-url"; label: "PureConnect ICWS base URL"; required: true; }, { id: "genesys-pureconnect-session"; label: "PureConnect ICWS session/authentication"; required: false; }, { id: "genesys-pureconnect-routing"; label: "PureConnect Interaction Web Tools routing configuration"; required: false; }]; directions: readonly ["inbound-only", "outbound-only", "bidirectional"]; id: "contact-center.genesys-pureconnect"; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { implementation: { adapterKind: "no-official-sdk-rest-adapter"; allowedOperations: readonly [{ alias: "genesys-pureconnect.icws.connect"; checksum: "not-available-html-doc"; id: "createConnection"; method: "POST"; path: "/icws/connection"; source: "https://help.genesys.com/developer/cic/docs/icws/webhelp/icws/connection/index.htm"; }, { alias: "genesys-pureconnect.icws.request"; checksum: "not-applicable-host-configured"; id: "sessionRequest"; method: "GET"; path: "host-configured-icws-session-path"; requiresHostReviewedPath: true; source: "host-configured"; }]; implementationStrategy: "provider-rest-adapter"; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ package: "genesys-pureconnect"; reason: "No npm package with this official PureConnect runtime SDK name was found."; result: "not-published"; }, { package: "pureconnect"; reason: "No npm package with this official PureConnect runtime SDK name was found."; result: "not-published"; }, { checkedVersion: "0.1.0"; license: "MIT"; package: "machinepack-ic"; reason: "Third-party ICWS wrapper, not an official maintained Genesys PureConnect runtime SDK."; result: "third-party-unmaintained-icws-package"; }, { checkedVersion: "255.1.0"; license: "MIT"; package: "purecloud-platform-client-v2"; reason: "Maintained SDK targets Genesys Cloud Platform APIs, not PureConnect ICWS."; result: "genesys-cloud-sdk-not-pureconnect-icws"; }]; defaultRestPolicy: "fail-closed-icws-rest-adapter-with-typed-provider-client-override"; result: "no-maintained-official-pureconnect-icws-npm-sdk"; typedClientOverride: "GenesysPureConnectProviderClient"; }; sdkAudit: { checkedPackages: readonly [{ name: "genesys-pureconnect"; result: "not-published"; }, { name: "pureconnect"; result: "not-published"; }, { name: "purecloud-platform-client-v2"; result: "maintained-genesys-cloud-sdk-not-pureconnect-icws"; }, { latest: "0.1.0"; name: "machinepack-ic"; publishedAt: "2015-08-11"; result: "third-party-unmaintained-icws-package"; }]; maintainedRuntimeSdk: false; registry: "npm"; }; sdkDecision: "No maintained Genesys PureConnect ICWS npm runtime SDK was verified; the official ICWS SDK page describes a REST API/docs, so this package provides a typed REST adapter with providerClient override."; verifiedAt: "2026-06-25"; }; manifestOnlySafe: true; providerRestAdapter: { adapterKind: "no-official-sdk-rest-adapter"; providerClientOverride: "GenesysPureConnectProviderClient"; strategy: "provider-rest-adapter"; }; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ package: "genesys-pureconnect"; reason: "No npm package with this official PureConnect runtime SDK name was found."; result: "not-published"; }, { package: "pureconnect"; reason: "No npm package with this official PureConnect runtime SDK name was found."; result: "not-published"; }, { checkedVersion: "0.1.0"; license: "MIT"; package: "machinepack-ic"; reason: "Third-party ICWS wrapper, not an official maintained Genesys PureConnect runtime SDK."; result: "third-party-unmaintained-icws-package"; }, { checkedVersion: "255.1.0"; license: "MIT"; package: "purecloud-platform-client-v2"; reason: "Maintained SDK targets Genesys Cloud Platform APIs, not PureConnect ICWS."; result: "genesys-cloud-sdk-not-pureconnect-icws"; }]; defaultRestPolicy: "fail-closed-icws-rest-adapter-with-typed-provider-client-override"; result: "no-maintained-official-pureconnect-icws-npm-sdk"; typedClientOverride: "GenesysPureConnectProviderClient"; }; }; name: "Genesys PureConnect / ICWS"; operations: readonly [{ alias: "contact-center.handoff.request"; capability: "handoff"; providerObject: "contactTransfer"; }, { alias: "genesys-pureconnect.icws.connect"; capability: "create-provider-object"; extension: true; providerObject: "contact"; }, { alias: "genesys-pureconnect.icws.request"; capability: "read-provider-object"; extension: true; providerObject: "contact"; }]; packageName: "@cognidesk/integration-contact-center-genesys-pureconnect"; provider: "genesys-pureconnect"; trustLevel: "official"; }, unknown, { contact-center.handoff.request: (input) => Promise\<ProviderJsonObject>; genesys-pureconnect.icws.connect: (input) => Promise\<ProviderJsonObject>; genesys-pureconnect.icws.request: (input) => Promise\<ProviderJsonObject>; }>

createGenesysPureConnectIntegrationOperationHandlers()¶

function createGenesysPureConnectIntegrationOperationHandlers(options?): {
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.connect: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.request: (input) => Promise<ProviderJsonObject>;
};

Parameters¶

Parameter	Type
`options?`	`GenesysPureConnectIntegrationOptions`

Returns¶

{
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.connect: (input) => Promise<ProviderJsonObject>;
  genesys-pureconnect.icws.request: (input) => Promise<ProviderJsonObject>;
}

Name	Type
`contact-center.handoff.request()`	(`input`) => `Promise`\<`ProviderJsonObject`>
`genesys-pureconnect.icws.connect()`	(`input`) => `Promise`\<`ProviderJsonObject`>
`genesys-pureconnect.icws.request()`	(`input`) => `Promise`\<`ProviderJsonObject`>

References¶