Interface WebIntegrationsAPI

interface WebIntegrationsAPI {
    clearCache: () => void;
    createWebIntegration: (
        body: WebIntegrationPostSchema,
        options?: ApiCallOptions,
    ) => Promise<CreateWebIntegrationHttpResponse>;
    deleteWebIntegration: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteWebIntegrationHttpResponse>;
    getWebIntegration: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetWebIntegrationHttpResponse>;
    getWebIntegrations: (
        query: {
            endingBefore?: string;
            limit?: number;
            sort?: "name" | "-name" | "+name";
            startingAfter?: string;
            tenantId?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetWebIntegrationsHttpResponse>;
    patchWebIntegration: (
        id: string,
        body: WebIntegrationPatchSchema,
        options?: ApiCallOptions,
    ) => Promise<PatchWebIntegrationHttpResponse>;
}
Index

Properties

clearCache createWebIntegration deleteWebIntegration getWebIntegration getWebIntegrations patchWebIntegration

Properties

clearCache: () => void

Clears the cache for web-integrations api requests.

Type declaration

    • (): void

    • Clears the cache for web-integrations api requests.

      Returns void

createWebIntegration: (
    body: WebIntegrationPostSchema,
    options?: ApiCallOptions,
) => Promise<CreateWebIntegrationHttpResponse>

Creates a web integration.

Type declaration

Param: body

an object with the body content

CreateWebIntegrationHttpError

deleteWebIntegration: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteWebIntegrationHttpResponse>

Deletes a single web integration by ID.

Type declaration

The ID of the web integration to delete.

DeleteWebIntegrationHttpError

getWebIntegration: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetWebIntegrationHttpResponse>

Retrieves a single web integration by ID.

Type declaration

The ID of the web integration to retrieve.

GetWebIntegrationHttpError

getWebIntegrations: (
    query: {
        endingBefore?: string;
        limit?: number;
        sort?: "name" | "-name" | "+name";
        startingAfter?: string;
        tenantId?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetWebIntegrationsHttpResponse>

Retrieves web integrations matching the query.

Type declaration

    • (
          query: {
              endingBefore?: string;
              limit?: number;
              sort?: "name" | "-name" | "+name";
              startingAfter?: string;
              tenantId?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetWebIntegrationsHttpResponse>

    • Retrieves web integrations matching the query.

      Parameters

      • query: {
            endingBefore?: string;
            limit?: number;
            sort?: "name" | "-name" | "+name";
            startingAfter?: string;
            tenantId?: string;
        }

        an object with query parameters

        • OptionalendingBefore?: string

          The target web integration ID to start looking before for web integrations. Cannot be used in conjunction with startingAfter.

        • Optionallimit?: number

          The number of web integration entries to retrieve.

        • Optionalsort?: "name" | "-name" | "+name"

          The field to sort by. Prefix with +/- to indicate ascending/descending order.

        • OptionalstartingAfter?: string

          The target web integration ID to start looking after for web integrations. Cannot be used in conjunction with endingBefore.

        • OptionaltenantId?: string

          The tenant ID to filter by.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetWebIntegrationsHttpResponse>

      GetWebIntegrationsHttpError

an object with query parameters

GetWebIntegrationsHttpError

patchWebIntegration: (
    id: string,
    body: WebIntegrationPatchSchema,
    options?: ApiCallOptions,
) => Promise<PatchWebIntegrationHttpResponse>

Updates a single web integration by ID.

Type declaration

The ID of the web integration to update.

Param: body

an object with the body content

PatchWebIntegrationHttpError

Settings

Member Visibility

On This Page

Properties