Type Alias WebIntegrationsAPI

type WebIntegrationsAPI = {
    clearCache: typeof clearCache;
    createWebIntegration: typeof createWebIntegration;
    deleteWebIntegration: typeof deleteWebIntegration;
    getWebIntegration: typeof getWebIntegration;
    getWebIntegrations: typeof getWebIntegrations;
    patchWebIntegration: typeof patchWebIntegration;
}
Index

Properties

clearCache createWebIntegration deleteWebIntegration getWebIntegration getWebIntegrations patchWebIntegration

Properties

clearCache: typeof clearCache

Clears the cache for web-integrations api requests.

createWebIntegration: typeof createWebIntegration

Creates a web integration.

Param: body

an object with the body content

CreateWebIntegrationHttpError

deleteWebIntegration: typeof deleteWebIntegration

Deletes a single web integration by ID.

The ID of the web integration to delete.

DeleteWebIntegrationHttpError

getWebIntegration: typeof getWebIntegration

Retrieves a single web integration by ID.

The ID of the web integration to retrieve.

GetWebIntegrationHttpError

getWebIntegrations: typeof getWebIntegrations

Retrieves web integrations matching the query.

an object with query parameters

GetWebIntegrationsHttpError

patchWebIntegration: typeof patchWebIntegration

Updates a single web integration by ID.

The ID of the web integration to update.

Param: body

an object with the body content

PatchWebIntegrationHttpError

Settings

Member Visibility

On This Page

Properties