runtime¶

Interfaces¶

CreateHelpCenterClientOptions¶

Extended by¶

CognideskHelpCenterIntegrationOptions

Properties¶

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

retry?¶

optional retry?: number | ProviderJsonRetryOptions;

signal?¶

optional signal?: AbortSignal;

sourceClientFactory?¶

optional sourceClientFactory?: HelpCenterSourceClientFactory;

timeoutMs?¶

optional timeoutMs?: number;

HelpCenterArticle¶

Properties¶

body?¶

optional body?: string;

id¶

id: string;

locale?¶

optional locale?: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

summary?¶

optional summary?: string;

tags?¶

optional tags?: string[];

title¶

title: string;

updatedAt?¶

optional updatedAt?: string;

url?¶

optional url?: string;

HelpCenterClient¶

Extended by¶

HelpCenterProviderClient

Methods¶

fetchArticle()¶

fetchArticle(articleId): Promise<HelpCenterArticle>;

Parameters¶

Parameter	Type
`articleId`	`string`

Returns¶

Promise\<HelpCenterArticle>

readiness()¶

readiness(): Promise<HelpCenterProviderResponse>;

Returns¶

Promise\<HelpCenterProviderResponse>

search()¶

search(input): Promise<HelpCenterSearchResult>;

Parameters¶

Parameter	Type
`input`	`HelpCenterSearchInput`

Returns¶

Promise\<HelpCenterSearchResult>

HelpCenterCredentialStatusInput¶

Properties¶

scopes?¶

optional scopes?: string[];

sourceConfigured?¶

optional sourceConfigured?: boolean;

webhookSecretConfigured?¶

optional webhookSecretConfigured?: boolean;

HelpCenterHttpEndpoints¶

Properties¶

article?¶

optional article?: string;

readiness?¶

optional readiness?: string;

search?¶

optional search?: string;

searchMethod?¶

optional searchMethod?: HelpCenterHttpMethod;

HelpCenterIngestionEvent¶

Properties¶

article¶

article: HelpCenterArticle;

channel¶

channel: {
  capabilities: {
     async: boolean;
     attachments: boolean;
     audioInput: boolean;
     audioOutput: boolean;
     buttons: boolean;
     deliveryReceipts: boolean;
     files: boolean;
     html: boolean;
     images: boolean;
     markdown: boolean;
     privateReplies: boolean;
     publicReplies: boolean;
     quickReplies: boolean;
     readReceipts: boolean;
     realtime: boolean;
     richText: boolean;
     supportsHumanTransfer: boolean;
     templates: boolean;
     threaded: boolean;
     typingIndicator: boolean;
     voice: boolean;
     widgets: boolean;
  };
  channelId: string;
  externalConversationId?: string;
  externalMessageId?: string;
  externalThreadId?: string;
  externalUserId?: string;
  kind: string;
  locale?: string;
  metadata?: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
  provider?: string;
  timezone?: string;
};

capabilities¶

capabilities: {
  async: boolean;
  attachments: boolean;
  audioInput: boolean;
  audioOutput: boolean;
  buttons: boolean;
  deliveryReceipts: boolean;
  files: boolean;
  html: boolean;
  images: boolean;
  markdown: boolean;
  privateReplies: boolean;
  publicReplies: boolean;
  quickReplies: boolean;
  readReceipts: boolean;
  realtime: boolean;
  richText: boolean;
  supportsHumanTransfer: boolean;
  templates: boolean;
  threaded: boolean;
  typingIndicator: boolean;
  voice: boolean;
  widgets: boolean;
};

capabilities.async¶

async: boolean;

capabilities.attachments¶

attachments: boolean;

capabilities.audioInput¶

audioInput: boolean;

capabilities.audioOutput¶

audioOutput: boolean;

capabilities.buttons¶

buttons: boolean;

capabilities.deliveryReceipts¶

deliveryReceipts: boolean;

capabilities.files¶

files: boolean;

capabilities.html¶

html: boolean;

capabilities.images¶

images: boolean;

capabilities.markdown¶

markdown: boolean;

capabilities.privateReplies¶

privateReplies: boolean;

capabilities.publicReplies¶

publicReplies: boolean;

capabilities.quickReplies¶

quickReplies: boolean;

capabilities.readReceipts¶

readReceipts: boolean;

capabilities.realtime¶

realtime: boolean;

capabilities.richText¶

richText: boolean;

capabilities.supportsHumanTransfer¶

supportsHumanTransfer: boolean;

capabilities.templates¶

templates: boolean;

capabilities.threaded¶

threaded: boolean;

capabilities.typingIndicator¶

typingIndicator: boolean;

capabilities.voice¶

voice: boolean;

capabilities.widgets¶

widgets: boolean;

channelId¶

channelId: string;

externalConversationId?¶

optional externalConversationId?: string;

externalMessageId?¶

optional externalMessageId?: string;

externalThreadId?¶

optional externalThreadId?: string;

externalUserId?¶

optional externalUserId?: string;

kind¶

kind: string;

locale?¶

optional locale?: string;

metadata?¶

optional metadata?: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;

provider?¶

optional provider?: string;

timezone?¶

optional timezone?: string;

id¶

id: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

occurredAt¶

occurredAt: string;

sourceId¶

sourceId: string;

type¶

type: "channel.help-center.article.ingested";

HelpCenterJsonObject¶

Indexable¶

[key: string]: HelpCenterProviderExtensionValue

HelpCenterProviderClient¶

Extends¶

HelpCenterClient

Methods¶

fetchArticle()¶

fetchArticle(articleId): Promise<HelpCenterArticle>;

Parameters¶

Parameter	Type
`articleId`	`string`

Returns¶

Promise\<HelpCenterArticle>

Inherited from¶

HelpCenterClient.fetchArticle

readiness()¶

readiness(): Promise<HelpCenterProviderResponse>;

Returns¶

Promise\<HelpCenterProviderResponse>

Inherited from¶

HelpCenterClient.readiness

search()¶

search(input): Promise<HelpCenterSearchResult>;

Parameters¶

Parameter	Type
`input`	`HelpCenterSearchInput`

Returns¶

Promise\<HelpCenterSearchResult>

Inherited from¶

HelpCenterClient.search

HelpCenterProviderExtensionFields¶

Extends¶

HelpCenterJsonObject

Indexable¶

[key: string]: HelpCenterProviderExtensionValue

HelpCenterProviderResponse¶

Extends¶

HelpCenterJsonObject

Indexable¶

[key: string]: HelpCenterProviderExtensionValue

HelpCenterSearchEvent¶

Properties¶

channel¶

channel: {
  capabilities: {
     async: boolean;
     attachments: boolean;
     audioInput: boolean;
     audioOutput: boolean;
     buttons: boolean;
     deliveryReceipts: boolean;
     files: boolean;
     html: boolean;
     images: boolean;
     markdown: boolean;
     privateReplies: boolean;
     publicReplies: boolean;
     quickReplies: boolean;
     readReceipts: boolean;
     realtime: boolean;
     richText: boolean;
     supportsHumanTransfer: boolean;
     templates: boolean;
     threaded: boolean;
     typingIndicator: boolean;
     voice: boolean;
     widgets: boolean;
  };
  channelId: string;
  externalConversationId?: string;
  externalMessageId?: string;
  externalThreadId?: string;
  externalUserId?: string;
  kind: string;
  locale?: string;
  metadata?: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
  provider?: string;
  timezone?: string;
};

capabilities¶

capabilities: {
  async: boolean;
  attachments: boolean;
  audioInput: boolean;
  audioOutput: boolean;
  buttons: boolean;
  deliveryReceipts: boolean;
  files: boolean;
  html: boolean;
  images: boolean;
  markdown: boolean;
  privateReplies: boolean;
  publicReplies: boolean;
  quickReplies: boolean;
  readReceipts: boolean;
  realtime: boolean;
  richText: boolean;
  supportsHumanTransfer: boolean;
  templates: boolean;
  threaded: boolean;
  typingIndicator: boolean;
  voice: boolean;
  widgets: boolean;
};

capabilities.async¶

async: boolean;

capabilities.attachments¶

attachments: boolean;

capabilities.audioInput¶

audioInput: boolean;

capabilities.audioOutput¶

audioOutput: boolean;

capabilities.buttons¶

buttons: boolean;

capabilities.deliveryReceipts¶

deliveryReceipts: boolean;

capabilities.files¶

files: boolean;

capabilities.html¶

html: boolean;

capabilities.images¶

images: boolean;

capabilities.markdown¶

markdown: boolean;

capabilities.privateReplies¶

privateReplies: boolean;

capabilities.publicReplies¶

publicReplies: boolean;

capabilities.quickReplies¶

quickReplies: boolean;

capabilities.readReceipts¶

readReceipts: boolean;

capabilities.realtime¶

realtime: boolean;

capabilities.richText¶

richText: boolean;

capabilities.supportsHumanTransfer¶

supportsHumanTransfer: boolean;

capabilities.templates¶

templates: boolean;

capabilities.threaded¶

threaded: boolean;

capabilities.typingIndicator¶

typingIndicator: boolean;

capabilities.voice¶

voice: boolean;

capabilities.widgets¶

widgets: boolean;

channelId¶

channelId: string;

externalConversationId?¶

optional externalConversationId?: string;

externalMessageId?¶

optional externalMessageId?: string;

externalThreadId?¶

optional externalThreadId?: string;

externalUserId?¶

optional externalUserId?: string;

kind¶

kind: string;

locale?¶

optional locale?: string;

metadata?¶

optional metadata?: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;

provider?¶

optional provider?: string;

timezone?¶

optional timezone?: string;

id¶

id: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

occurredAt¶

occurredAt: string;

query¶

query: HelpCenterSearchInput;

resultCount¶

resultCount: number;

sourceId¶

sourceId: string;

type¶

type: "channel.help-center.search.performed";

HelpCenterSearchInput¶

Properties¶

cursor?¶

optional cursor?: string;

limit?¶

optional limit?: number;

locale?¶

optional locale?: string;

query¶

query: string;

HelpCenterSearchResult¶

Properties¶

articles¶

articles: HelpCenterArticle[];

cursor?¶

optional cursor?: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

HelpCenterWebhookPayload¶

Properties¶

article?¶

optional article?: HelpCenterArticle;

event¶

event: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

sourceId?¶

optional sourceId?: string;

HttpHelpCenterSource¶

Properties¶

accessToken?¶

optional accessToken?: string;

apiKey?¶

optional apiKey?: string;

baseUrl?¶

optional baseUrl?: string;

endpoints?¶

optional endpoints?: HelpCenterHttpEndpoints;

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>

headers?¶

optional headers?: Record<string, string>;

id¶

id: string;

metadata?¶

optional metadata?: HelpCenterProviderExtensionFields;

providerClient?¶

optional providerClient?: HelpCenterProviderClient;

type¶

type: "http";

LocalHelpCenterSource¶

Properties¶

articles¶

articles: HelpCenterArticle[];

id¶

id: string;

type¶

type: "local";

ParseHelpCenterWebhookOptions¶

Properties¶

rawBody?¶

optional rawBody?: string;

requireSignature?¶

optional requireSignature?: boolean;

secret?¶

optional secret?: string;

signatureHeader?¶

optional signatureHeader?: string;

ProviderJsonRetryOptions¶

Properties¶

attempts?¶

optional attempts?: number;

baseDelayMs?¶

optional baseDelayMs?: number;

maxDelayMs?¶

optional maxDelayMs?: number;

statusCodes?¶

optional statusCodes?: readonly number[];

Type Aliases¶

HelpCenterHttpMethod¶

type HelpCenterHttpMethod = "GET" | "POST";

HelpCenterJsonPrimitive¶

type HelpCenterJsonPrimitive = string | number | boolean | null;

HelpCenterJsonValue¶

type HelpCenterJsonValue =
  | HelpCenterJsonPrimitive
  | HelpCenterJsonObject
  | readonly HelpCenterJsonValue[];

HelpCenterProviderExtensionValue¶

type HelpCenterProviderExtensionValue = HelpCenterJsonValue | object | undefined;

HelpCenterProviderPayload¶

type HelpCenterProviderPayload = HelpCenterJsonObject | object;

HelpCenterProviderQuery¶

type HelpCenterProviderQuery = Record<string, HelpCenterProviderExtensionValue>;

HelpCenterSource¶

type HelpCenterSource =
  | LocalHelpCenterSource
  | HttpHelpCenterSource;

HelpCenterSourceClientFactory¶

type HelpCenterSourceClientFactory = (source) => HelpCenterProviderClient | undefined;

Parameters¶

Parameter	Type
`source`	`HttpHelpCenterSource`

Returns¶

HelpCenterProviderClient | undefined

Functions¶

createDefaultHelpCenterSourceClient()¶

function createDefaultHelpCenterSourceClient(source, options?): HelpCenterProviderClient;

Parameters¶

Parameter	Type
`source`	`HttpHelpCenterSource`
`options?`	`Pick`\<`CreateHelpCenterClientOptions`, `"fetch"` \| `"signal"` \| `"timeoutMs"` \| `"retry"`>

Returns¶

HelpCenterProviderClient

createHelpCenterClient()¶

function createHelpCenterClient(sourceInput, options?): HelpCenterClient;

Parameters¶

Parameter	Type
`sourceInput`	`HelpCenterSource`
`options?`	`CreateHelpCenterClientOptions`

Returns¶

HelpCenterClient

createHelpCenterSourceClientFactory()¶

function createHelpCenterSourceClientFactory(options?): HelpCenterSourceClientFactory;

Parameters¶

Parameter	Type
`options?`	`Pick`\<`CreateHelpCenterClientOptions`, `"fetch"` \| `"signal"` \| `"timeoutMs"` \| `"retry"`>

Returns¶

HelpCenterSourceClientFactory

createHttpHelpCenterSourceClient()¶

function createHttpHelpCenterSourceClient(source, options?): HelpCenterProviderClient;

Parameters¶

Parameter	Type
`source`	`HttpHelpCenterSource`
`options?`	`Pick`\<`CreateHelpCenterClientOptions`, `"fetch"` \| `"signal"` \| `"timeoutMs"` \| `"retry"`>

Returns¶

HelpCenterProviderClient

createUnconfiguredHelpCenterProviderClient()¶

function createUnconfiguredHelpCenterProviderClient(sourceId?): HelpCenterProviderClient;

Parameters¶

Parameter	Type
`sourceId?`	`string`

Returns¶

HelpCenterProviderClient

defineHelpCenterSource()¶

function defineHelpCenterSource(source): HelpCenterSource;

Parameters¶

Parameter	Type
`source`	`HelpCenterSource`

Returns¶

HelpCenterSource

guardHelpCenterFetch()¶

function guardHelpCenterFetch(fetchImpl, sourceId): {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Parameters¶

Parameter	Type
`fetchImpl`	{ (`input`, `init?`): `Promise`\<`Response`>; (`input`, `init?`): `Promise`\<`Response`>; }
`sourceId`	`string`

Returns¶

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

MDN Reference

Parameters¶

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

Returns¶

Promise\<Response>

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

MDN Reference

Parameters¶

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

Returns¶

Promise\<Response>

helpCenterCredentialStatuses()¶

function helpCenterCredentialStatuses(input): {
  expiresAt?: string;
  message?: string;
  providerPackageId?: string;
  requirementId: string;
  scopes?: string[];
  state:   | "required"
     | "configured"
     | "permission-blocked"
     | "not-required"
     | "missing"
     | "expired"
     | "insufficient-scope"
     | "unavailable";
}[];

Parameters¶

Parameter	Type
`input`	`HelpCenterCredentialStatusInput`

Returns¶

{ expiresAt?: string; message?: string; providerPackageId?: string; requirementId: string; scopes?: string[]; state: | "required" | "configured" | "permission-blocked" | "not-required" | "missing" | "expired" | "insufficient-scope" | "unavailable"; }[]

normalizeHelpCenterIngestionEvent()¶

function normalizeHelpCenterIngestionEvent(input): HelpCenterIngestionEvent;

Parameters¶

Parameter	Type
`input`	{ `article`: `HelpCenterArticle`; `metadata?`: `HelpCenterProviderExtensionFields`; `occurredAt?`: `string`; `sourceId`: `string`; }
`input.article`	`HelpCenterArticle`
`input.metadata?`	`HelpCenterProviderExtensionFields`
`input.occurredAt?`	`string`
`input.sourceId`	`string`

Returns¶

HelpCenterIngestionEvent

normalizeHelpCenterSearchEvent()¶

function normalizeHelpCenterSearchEvent(input): HelpCenterSearchEvent;

Parameters¶

Parameter	Type
`input`	{ `metadata?`: `HelpCenterProviderExtensionFields`; `occurredAt?`: `string`; `query`: `HelpCenterSearchInput`; `result`: `HelpCenterSearchResult`; `sourceId`: `string`; }
`input.metadata?`	`HelpCenterProviderExtensionFields`
`input.occurredAt?`	`string`
`input.query`	`HelpCenterSearchInput`
`input.result`	`HelpCenterSearchResult`
`input.sourceId`	`string`

Returns¶

HelpCenterSearchEvent

parseHelpCenterWebhook()¶

function parseHelpCenterWebhook(request, options?): Promise<HelpCenterWebhookPayload>;

Parameters¶

Parameter	Type
`request`	`Request`
`options?`	`ParseHelpCenterWebhookOptions`

Returns¶

Promise\<HelpCenterWebhookPayload>

validateHelpCenterWebhookSignature()¶

function validateHelpCenterWebhookSignature(input): boolean;

Parameters¶

Parameter	Type
`input`	{ `rawBody`: `string`; `secret`: `string`; `signature`: `string`; }
`input.rawBody`	`string`
`input.secret`	`string`
`input.signature`	`string`

Returns¶

boolean