integrations/help-center/cognidesk/dist

Interfaces

CognideskHelpCenterIntegrationOptions

Extends

• CreateHelpCenterClientOptions

Properties

client?

optional client?: HelpCenterClient;

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

CreateHelpCenterClientOptions.fetch

providerClient?

optional providerClient?: HelpCenterProviderClient;

Inherited from

CreateHelpCenterClientOptions.providerClient

retry?

optional retry?:
  | number
  | ProviderJsonRetryOptions;

Inherited from

CreateHelpCenterClientOptions.retry

signal?

optional signal?: AbortSignal;

Inherited from

CreateHelpCenterClientOptions.signal

source

source: HelpCenterSource;

sourceClientFactory?

optional sourceClientFactory?: HelpCenterSourceClientFactory;

Inherited from

CreateHelpCenterClientOptions.sourceClientFactory

timeoutMs?

optional timeoutMs?: number;

Inherited from

CreateHelpCenterClientOptions.timeoutMs

---

ParseHelpCenterWebhookOperationInput

Properties

options?

optional options?: ParseHelpCenterWebhookOptions;

request

request: Request;

Functions

createCognideskHelpCenterIntegration()

function createCognideskHelpCenterIntegration(options): DefinedIntegration<never, unknown, never>;

Parameters

Parameter	Type
options	CognideskHelpCenterIntegrationOptions

Returns

DefinedIntegration\<never, unknown, never>

References

cognideskHelpCenterProviderManifest

Re-exports cognideskHelpCenterProviderManifest

---

createDefaultHelpCenterSourceClient

Re-exports createDefaultHelpCenterSourceClient

---

createHelpCenterClient

Re-exports createHelpCenterClient

---

CreateHelpCenterClientOptions

Re-exports CreateHelpCenterClientOptions

---

createHelpCenterSourceClientFactory

Re-exports createHelpCenterSourceClientFactory

---

createHttpHelpCenterSourceClient

Re-exports createHttpHelpCenterSourceClient

---

createUnconfiguredHelpCenterProviderClient

Re-exports createUnconfiguredHelpCenterProviderClient

---

defineHelpCenterSource

Re-exports defineHelpCenterSource

---

guardHelpCenterFetch

Re-exports guardHelpCenterFetch

---

HelpCenterArticle

Re-exports HelpCenterArticle

---

HelpCenterClient

Re-exports HelpCenterClient

---

helpCenterCredentialStatuses

Re-exports helpCenterCredentialStatuses

---

HelpCenterCredentialStatusInput

Re-exports HelpCenterCredentialStatusInput

---

HelpCenterHttpEndpoints

Re-exports HelpCenterHttpEndpoints

---

HelpCenterHttpMethod

Re-exports HelpCenterHttpMethod

---

HelpCenterIngestionEvent

Re-exports HelpCenterIngestionEvent

---

HelpCenterJsonObject

Re-exports HelpCenterJsonObject

---

HelpCenterJsonPrimitive

Re-exports HelpCenterJsonPrimitive

---

HelpCenterJsonValue

Re-exports HelpCenterJsonValue

---

HelpCenterProviderClient

Re-exports HelpCenterProviderClient

---

HelpCenterProviderExtensionFields

Re-exports HelpCenterProviderExtensionFields

---

HelpCenterProviderExtensionValue

Re-exports HelpCenterProviderExtensionValue

---

HelpCenterProviderPayload

Re-exports HelpCenterProviderPayload

---

HelpCenterProviderQuery

Re-exports HelpCenterProviderQuery

---

HelpCenterProviderResponse

Re-exports HelpCenterProviderResponse

---

HelpCenterSearchEvent

Re-exports HelpCenterSearchEvent

---

HelpCenterSearchInput

Re-exports HelpCenterSearchInput

---

HelpCenterSearchResult

Re-exports HelpCenterSearchResult

---

HelpCenterSource

Re-exports HelpCenterSource

---

HelpCenterSourceClientFactory

Re-exports HelpCenterSourceClientFactory

---

HelpCenterWebhookPayload

Re-exports HelpCenterWebhookPayload

---

HttpHelpCenterSource

Re-exports HttpHelpCenterSource

---

LocalHelpCenterSource

Re-exports LocalHelpCenterSource

---

normalizeHelpCenterIngestionEvent

Re-exports normalizeHelpCenterIngestionEvent

---

normalizeHelpCenterSearchEvent

Re-exports normalizeHelpCenterSearchEvent

---

parseHelpCenterWebhook

Re-exports parseHelpCenterWebhook

---

ParseHelpCenterWebhookOptions

Re-exports ParseHelpCenterWebhookOptions

---

ProviderJsonRetryOptions

Re-exports ProviderJsonRetryOptions

---

validateHelpCenterWebhookSignature

Re-exports validateHelpCenterWebhookSignature