dist¶

Interfaces¶

ConfiguredHandoffInput¶

Properties¶

idempotencyKey?¶

optional idempotencyKey?: string;

payload?¶

optional payload?: NextivaJsonObject;

query?¶

optional query?: Record<string, ProviderQueryValue>;

NextivaClient¶

Properties¶

providerClient¶

providerClient: NextivaProviderClient;

Methods¶

createHandoff()¶

createHandoff(input?): Promise<NextivaJsonObject>;

Parameters¶

Parameter	Type
`input?`	`ConfiguredHandoffInput`

Returns¶

Promise\<NextivaJsonObject>

readiness()¶

readiness(): Promise<NextivaJsonObject>;

Returns¶

Promise\<NextivaJsonObject>

request()¶

request(input): Promise<NextivaJsonObject>;

Parameters¶

Parameter	Type
`input`	`ProviderExtensionRequestInput`

Returns¶

Promise\<NextivaJsonObject>

NextivaClientOptions¶

Extended by¶

NextivaIntegrationOptions

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?: NextivaProviderClient;

readinessPath?¶

optional readinessPath?: string;

retry?¶

optional retry?: number | ProviderRestRetryOptions;

signal?¶

optional signal?: AbortSignal;

timeoutMs?¶

optional timeoutMs?: number;

NextivaIntegrationOptions¶

Extends¶

NextivaClientOptions

Properties¶

accessToken?¶

optional accessToken?: string;

Inherited from¶

NextivaClientOptions.accessToken

apiBaseUrl?¶

optional apiBaseUrl?: string;

Inherited from¶

NextivaClientOptions.apiBaseUrl

apiKey?¶

optional apiKey?: string;

Inherited from¶

NextivaClientOptions.apiKey

apiKeyHeaderName?¶

optional apiKeyHeaderName?: string;

Inherited from¶

NextivaClientOptions.apiKeyHeaderName

authorizationHeader?¶

optional authorizationHeader?: string;

Inherited from¶

NextivaClientOptions.authorizationHeader

baseUrl?¶

optional baseUrl?: string;

Inherited from¶

NextivaClientOptions.baseUrl

defaultHandoffPath?¶

optional defaultHandoffPath?: string;

Inherited from¶

NextivaClientOptions.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¶

NextivaClientOptions.fetch

nextivaClient?¶

optional nextivaClient?: NextivaClient;

providerClient?¶

optional providerClient?: NextivaProviderClient;

Inherited from¶

NextivaClientOptions.providerClient

readinessPath?¶

optional readinessPath?: string;

Inherited from¶

NextivaClientOptions.readinessPath

retry?¶

optional retry?: number | ProviderRestRetryOptions;

Inherited from¶

NextivaClientOptions.retry

signal?¶

optional signal?: AbortSignal;

Inherited from¶

NextivaClientOptions.signal

timeoutMs?¶

optional timeoutMs?: number;

Inherited from¶

NextivaClientOptions.timeoutMs

NextivaJsonObject¶

Indexable¶

[key: string]: NextivaJsonValue

NextivaOperationInput¶

Extended by¶

ProviderExtensionRequestInput

Properties¶

body?¶

optional body?: NextivaJsonValue;

headers?¶

optional headers?: Record<string, string>;

idempotencyKey?¶

optional idempotencyKey?: string;

pathParams?¶

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

query?¶

optional query?: Record<string, ProviderQueryValue>;

NextivaProviderClient¶

Methods¶

createHandoff()¶

createHandoff(input): Promise<NextivaJsonObject>;

Parameters¶

Parameter	Type
`input`	`ConfiguredHandoffInput`

Returns¶

Promise\<NextivaJsonObject>

readiness()?¶

optional readiness(): Promise<NextivaJsonObject>;

Returns¶

Promise\<NextivaJsonObject>

request()¶

request(input): Promise<NextivaJsonObject>;

Parameters¶

Parameter	Type
`input`	`ProviderExtensionRequestInput`

Returns¶

Promise\<NextivaJsonObject>

ProviderExtensionRequestInput¶

Extends¶

NextivaOperationInput

Properties¶

allowMutation?¶

optional allowMutation?: boolean;

body?¶

optional body?: NextivaJsonValue;

Inherited from¶

NextivaOperationInput.body

classification?¶

optional classification?: string;

headers?¶

optional headers?: Record<string, string>;

Inherited from¶

NextivaOperationInput.headers

idempotencyKey?¶

optional idempotencyKey?: string;

Inherited from¶

NextivaOperationInput.idempotencyKey

method?¶

optional method?: ProviderHttpMethod;

operationId?¶

optional operationId?: string;

path?¶

optional path?: string;

pathParams?¶

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

Inherited from¶

NextivaOperationInput.pathParams

query?¶

optional query?: Record<string, ProviderQueryValue>;

Inherited from¶

NextivaOperationInput.query

ProviderRestRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

Type Aliases¶

NextivaJsonPrimitive¶

type NextivaJsonPrimitive = string | number | boolean | null;

NextivaJsonValue¶

type NextivaJsonValue =
  | NextivaJsonPrimitive
  | NextivaJsonObject
  | readonly NextivaJsonValue[];

ProviderJsonObject¶

type ProviderJsonObject = NextivaJsonObject;

Functions¶

createNextivaClient()¶

function createNextivaClient(options?): NextivaClient;

Parameters¶

Parameter	Type
`options?`	`NextivaClientOptions`

Returns¶

NextivaClient

createNextivaIntegration()¶

function createNextivaIntegration(options?): DefinedIntegration<{
  capabilities: readonly [{
     capability: "handoff";
     exposesSensitiveData: true;
     providerObjects: readonly [{
        kind: "contactTransfer";
        label: "contactTransfer";
     }];
     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: "Nextiva Contact Center REST APIs";
        url: "https://www.nextiva.com/resources/learn/rest-apis";
      }, {
        label: "Nextiva WorkItem Service";
        url: "https://developer.nextiva.com/nextiva/docs/workitem-service";
      }, {
        label: "Nextiva Frontend SDKs";
        url: "https://developer.nextiva.com/nextiva/docs/overview-of-sdks";
      }, {
        label: "Nextiva SDK Installation";
        url: "https://developer.nextiva.com/nextiva/docs/sdk-installation";
      }, {
        label: "Nextiva ncx-sdk";
        url: "https://github.com/Nextiva/ncx-sdk";
      }, {
        label: "Nextiva ncx-web-sdk";
        url: "https://github.com/Nextiva/ncx-web-sdk";
     }];
     notes: readonly ["No suitable public server-side Nextiva JavaScript SDK was verified for this provider runtime.", "Runtime calls use a strict typed REST adapter when baseUrl/API credentials are supplied, with NextivaProviderClient available as a host-client override.", "Nextiva's current SDK documentation describes frontend SDKs; public npm packages checked for NCX were frontend/session-oriented, dev/unlicensed, unavailable under documented scoped names, or too loosely typed for package-owned server runtime calls."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     id: "nextiva-contact-center-api-base";
     label: "Nextiva Contact Center API base URL";
     required: true;
   }, {
     id: "nextiva-contact-center-api-access";
     label: "Nextiva Contact Center API access";
     required: true;
   }, {
     id: "nextiva-contact-center-routing";
     label: "Nextiva queue/campaign/routing configuration";
     required: false;
  }];
  directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
  id: "contact-center.nextiva";
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     implementation: {
        adapterKind: "no-suitable-runtime-sdk-rest-adapter";
        allowedOperations: readonly [{
           alias: "contact-center.handoff.request";
           checksum: "not-applicable-host-configured";
           id: "configuredHandoff";
           method: "POST";
           path: "host-configured";
           source: "provider-rest-adapter";
        }];
        hostClientEscapeHatch: "NextivaClientOptions.providerClient";
        hostClientOverride: true;
        implementationStrategy: "provider-rest-adapter";
        packageOwnedRestClient: true;
        providerSdkDecision: {
           checkedAt: "2026-06-25";
           checkedPackages: readonly [{
              checkedVersion: "1.5.8";
              license: "MIT";
              package: "ncx-sdk";
              reason: "Session/frontend-oriented client with broad any-typed services and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations.";
              result: "not-used-as-runtime-rest-client";
            }, {
              checkedVersion: "0.0.1-dev.6";
              license: "UNLICENSED";
              package: "ncx-web-sdk";
              reason: "Dev-tagged browser Web SDK with browser telephony/UI peer surface and no suitable redistributable server-side runtime contract.";
              result: "not-used-as-runtime-rest-client";
            }, {
              checkedVersion: "0.0.1-dev.10";
              license: "UNLICENSED";
              package: "ncx-react-sdk";
              reason: "React frontend SDK is not appropriate for this provider runtime package.";
              result: "not-used-as-runtime-rest-client";
           }];
           defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
           result: "no-suitable-server-side-sdk";
           typedClientOverride: "NextivaProviderClient";
        };
        sdkDecision: {
           checkedAt: "2026-06-25";
           checkedPackages: readonly [{
              checkedVersion: "1.5.8";
              license: "MIT";
              package: "ncx-sdk";
              reason: "Public package is a session/frontend-oriented client with broad any-typed WorkitemsService methods and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations.";
              result: "not-used-as-runtime-rest-client";
            }, {
              checkedVersion: "0.0.1-dev.6";
              license: "UNLICENSED";
              package: "ncx-web-sdk";
              reason: "Public npm package is a dev-tagged browser Web SDK with peer dependencies for browser telephony/UI runtime and a tiny exported type surface; the scoped package documented by Nextiva was not available on the public npm registry during this check.";
              result: "not-used-as-runtime-rest-client";
            }, {
              checkedVersion: "0.0.1-dev.10";
              license: "UNLICENSED";
              package: "ncx-react-sdk";
              reason: "React frontend SDK depends on React and NCX core dev packages, so it is not appropriate for this provider runtime package.";
              result: "not-used-as-runtime-rest-client";
           }];
           result: "no-suitable-server-side-sdk";
        };
        verifiedAt: "2026-06-25";
     };
     manifestOnlySafe: true;
     providerRestAdapter: {
        adapterKind: "no-suitable-runtime-sdk-rest-adapter";
        packageOwnedRestClient: true;
        providerClientOverride: "NextivaProviderClient";
        requestValidation: "json-path-query-header-validated";
        strategy: "provider-rest-adapter";
     };
     providerSdkDecision: {
        checkedAt: "2026-06-25";
        checkedPackages: readonly [{
           checkedVersion: "1.5.8";
           license: "MIT";
           package: "ncx-sdk";
           reason: "Session/frontend-oriented client with broad any-typed services and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations.";
           result: "not-used-as-runtime-rest-client";
         }, {
           checkedVersion: "0.0.1-dev.6";
           license: "UNLICENSED";
           package: "ncx-web-sdk";
           reason: "Dev-tagged browser Web SDK with browser telephony/UI peer surface and no suitable redistributable server-side runtime contract.";
           result: "not-used-as-runtime-rest-client";
         }, {
           checkedVersion: "0.0.1-dev.10";
           license: "UNLICENSED";
           package: "ncx-react-sdk";
           reason: "React frontend SDK is not appropriate for this provider runtime package.";
           result: "not-used-as-runtime-rest-client";
        }];
        defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
        result: "no-suitable-server-side-sdk";
        typedClientOverride: "NextivaProviderClient";
     };
  };
  name: "Nextiva Contact Center";
  operations: readonly [{
     alias: "contact-center.handoff.request";
     capability: "handoff";
     providerObject: "contactTransfer";
   }, {
     alias: "nextiva.request";
     capability: "read-provider-object";
     extension: true;
     providerObject: "contact";
  }];
  packageName: "@cognidesk/integration-contact-center-nextiva";
  provider: "nextiva";
  trustLevel: "official";
}, unknown, {
  contact-center.handoff.request: (input) => Promise<NextivaJsonObject>;
  nextiva.request: (input) => Promise<NextivaJsonObject>;
}>;

Parameters¶

Parameter	Type
`options?`	`NextivaIntegrationOptions`

Returns¶

DefinedIntegration\<{ capabilities: readonly [{ capability: "handoff"; exposesSensitiveData: true; providerObjects: readonly [{ kind: "contactTransfer"; label: "contactTransfer"; }]; 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: "Nextiva Contact Center REST APIs"; url: "https://www.nextiva.com/resources/learn/rest-apis"; }, { label: "Nextiva WorkItem Service"; url: "https://developer.nextiva.com/nextiva/docs/workitem-service"; }, { label: "Nextiva Frontend SDKs"; url: "https://developer.nextiva.com/nextiva/docs/overview-of-sdks"; }, { label: "Nextiva SDK Installation"; url: "https://developer.nextiva.com/nextiva/docs/sdk-installation"; }, { label: "Nextiva ncx-sdk"; url: "https://github.com/Nextiva/ncx-sdk"; }, { label: "Nextiva ncx-web-sdk"; url: "https://github.com/Nextiva/ncx-web-sdk"; }]; notes: readonly ["No suitable public server-side Nextiva JavaScript SDK was verified for this provider runtime.", "Runtime calls use a strict typed REST adapter when baseUrl/API credentials are supplied, with NextivaProviderClient available as a host-client override.", "Nextiva's current SDK documentation describes frontend SDKs; public npm packages checked for NCX were frontend/session-oriented, dev/unlicensed, unavailable under documented scoped names, or too loosely typed for package-owned server runtime calls."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ id: "nextiva-contact-center-api-base"; label: "Nextiva Contact Center API base URL"; required: true; }, { id: "nextiva-contact-center-api-access"; label: "Nextiva Contact Center API access"; required: true; }, { id: "nextiva-contact-center-routing"; label: "Nextiva queue/campaign/routing configuration"; required: false; }]; directions: readonly ["inbound-only", "outbound-only", "bidirectional"]; id: "contact-center.nextiva"; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { implementation: { adapterKind: "no-suitable-runtime-sdk-rest-adapter"; allowedOperations: readonly [{ alias: "contact-center.handoff.request"; checksum: "not-applicable-host-configured"; id: "configuredHandoff"; method: "POST"; path: "host-configured"; source: "provider-rest-adapter"; }]; hostClientEscapeHatch: "NextivaClientOptions.providerClient"; hostClientOverride: true; implementationStrategy: "provider-rest-adapter"; packageOwnedRestClient: true; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ checkedVersion: "1.5.8"; license: "MIT"; package: "ncx-sdk"; reason: "Session/frontend-oriented client with broad any-typed services and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.6"; license: "UNLICENSED"; package: "ncx-web-sdk"; reason: "Dev-tagged browser Web SDK with browser telephony/UI peer surface and no suitable redistributable server-side runtime contract."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.10"; license: "UNLICENSED"; package: "ncx-react-sdk"; reason: "React frontend SDK is not appropriate for this provider runtime package."; result: "not-used-as-runtime-rest-client"; }]; defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override"; result: "no-suitable-server-side-sdk"; typedClientOverride: "NextivaProviderClient"; }; sdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ checkedVersion: "1.5.8"; license: "MIT"; package: "ncx-sdk"; reason: "Public package is a session/frontend-oriented client with broad any-typed WorkitemsService methods and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.6"; license: "UNLICENSED"; package: "ncx-web-sdk"; reason: "Public npm package is a dev-tagged browser Web SDK with peer dependencies for browser telephony/UI runtime and a tiny exported type surface; the scoped package documented by Nextiva was not available on the public npm registry during this check."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.10"; license: "UNLICENSED"; package: "ncx-react-sdk"; reason: "React frontend SDK depends on React and NCX core dev packages, so it is not appropriate for this provider runtime package."; result: "not-used-as-runtime-rest-client"; }]; result: "no-suitable-server-side-sdk"; }; verifiedAt: "2026-06-25"; }; manifestOnlySafe: true; providerRestAdapter: { adapterKind: "no-suitable-runtime-sdk-rest-adapter"; packageOwnedRestClient: true; providerClientOverride: "NextivaProviderClient"; requestValidation: "json-path-query-header-validated"; strategy: "provider-rest-adapter"; }; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ checkedVersion: "1.5.8"; license: "MIT"; package: "ncx-sdk"; reason: "Session/frontend-oriented client with broad any-typed services and socket/session initialization, not a strict server-side REST client for Cognidesk handoff operations."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.6"; license: "UNLICENSED"; package: "ncx-web-sdk"; reason: "Dev-tagged browser Web SDK with browser telephony/UI peer surface and no suitable redistributable server-side runtime contract."; result: "not-used-as-runtime-rest-client"; }, { checkedVersion: "0.0.1-dev.10"; license: "UNLICENSED"; package: "ncx-react-sdk"; reason: "React frontend SDK is not appropriate for this provider runtime package."; result: "not-used-as-runtime-rest-client"; }]; defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override"; result: "no-suitable-server-side-sdk"; typedClientOverride: "NextivaProviderClient"; }; }; name: "Nextiva Contact Center"; operations: readonly [{ alias: "contact-center.handoff.request"; capability: "handoff"; providerObject: "contactTransfer"; }, { alias: "nextiva.request"; capability: "read-provider-object"; extension: true; providerObject: "contact"; }]; packageName: "@cognidesk/integration-contact-center-nextiva"; provider: "nextiva"; trustLevel: "official"; }, unknown, { contact-center.handoff.request: (input) => Promise\<NextivaJsonObject>; nextiva.request: (input) => Promise\<NextivaJsonObject>; }>

createNextivaIntegrationOperationHandlers()¶

function createNextivaIntegrationOperationHandlers(options?): {
  contact-center.handoff.request: (input) => Promise<NextivaJsonObject>;
  nextiva.request: (input) => Promise<NextivaJsonObject>;
};

Parameters¶

Parameter	Type
`options?`	`NextivaIntegrationOptions`

Returns¶

{
  contact-center.handoff.request: (input) => Promise<NextivaJsonObject>;
  nextiva.request: (input) => Promise<NextivaJsonObject>;
}

Name	Type
`contact-center.handoff.request()`	(`input`) => `Promise`\<`NextivaJsonObject`>
`nextiva.request()`	(`input`) => `Promise`\<`NextivaJsonObject`>

References¶