cloudflare/resources/challenges/widgets.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as WidgetsAPI from 'cloudflare/resources/challenges/widgets';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class Widgets extends APIResource {
    /**
     * Lists challenge widgets.
     */
    create(params: WidgetCreateParams, options?: Core.RequestOptions): Core.APIPromise<Widget>;
    /**
     * Update the configuration of a widget.
     */
    update(sitekey: string, params: WidgetUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Widget>;
    /**
     * Lists all turnstile widgets of an account.
     */
    list(params: WidgetListParams, options?: Core.RequestOptions): Core.PagePromise<WidgetListResponsesV4PagePaginationArray, WidgetListResponse>;
    /**
     * Destroy a Turnstile Widget.
     */
    delete(sitekey: string, params: WidgetDeleteParams, options?: Core.RequestOptions): Core.APIPromise<Widget>;
    /**
     * Show a single challenge widget configuration.
     */
    get(sitekey: string, params: WidgetGetParams, options?: Core.RequestOptions): Core.APIPromise<Widget>;
    /**
     * Generate a new secret key for this widget. If `invalidate_immediately` is set to
     * `false`, the previous secret remains valid for 2 hours.
     *
     * Note that secrets cannot be rotated again during the grace period.
     */
    rotateSecret(sitekey: string, params: WidgetRotateSecretParams, options?: Core.RequestOptions): Core.APIPromise<Widget>;
}
export declare class WidgetListResponsesV4PagePaginationArray extends V4PagePaginationArray<WidgetListResponse> {
}
/**
 * A Turnstile widget's detailed configuration
 */
export interface Widget {
    /**
     * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
     * challenges in response to malicious bots (ENT only).
     */
    bot_fight_mode: boolean;
    /**
     * If Turnstile is embedded on a Cloudflare site and the widget should grant
     * challenge clearance, this setting can determine the clearance level to be set
     */
    clearance_level: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
    /**
     * When the widget was created.
     */
    created_on: string;
    domains: Array<WidgetDomain>;
    /**
     * Widget Mode
     */
    mode: 'non-interactive' | 'invisible' | 'managed';
    /**
     * When the widget was modified.
     */
    modified_on: string;
    /**
     * Human readable widget name. Not unique. Cloudflare suggests that you set this to
     * a meaningful string to make it easier to identify your widget, and where it is
     * used.
     */
    name: string;
    /**
     * Do not show any Cloudflare branding on the widget (ENT only).
     */
    offlabel: boolean;
    /**
     * Region where this widget can be used.
     */
    region: 'world';
    /**
     * Secret key for this widget.
     */
    secret: string;
    /**
     * Widget item identifier tag.
     */
    sitekey: string;
}
/**
 * Hosts as a hostname or IPv4/IPv6 address represented by strings. The widget will
 * only work on these domains, and their subdomains.
 */
export type WidgetDomain = string;
/**
 * A Turnstile Widgets configuration as it appears in listings
 */
export interface WidgetListResponse {
    /**
     * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
     * challenges in response to malicious bots (ENT only).
     */
    bot_fight_mode: boolean;
    /**
     * If Turnstile is embedded on a Cloudflare site and the widget should grant
     * challenge clearance, this setting can determine the clearance level to be set
     */
    clearance_level: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
    /**
     * When the widget was created.
     */
    created_on: string;
    domains: Array<WidgetDomain>;
    /**
     * Widget Mode
     */
    mode: 'non-interactive' | 'invisible' | 'managed';
    /**
     * When the widget was modified.
     */
    modified_on: string;
    /**
     * Human readable widget name. Not unique. Cloudflare suggests that you set this to
     * a meaningful string to make it easier to identify your widget, and where it is
     * used.
     */
    name: string;
    /**
     * Do not show any Cloudflare branding on the widget (ENT only).
     */
    offlabel: boolean;
    /**
     * Region where this widget can be used.
     */
    region: 'world';
    /**
     * Widget item identifier tag.
     */
    sitekey: string;
}
export interface WidgetCreateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    domains: Array<WidgetDomain>;
    /**
     * Body param: Widget Mode
     */
    mode: 'non-interactive' | 'invisible' | 'managed';
    /**
     * Body param: Human readable widget name. Not unique. Cloudflare suggests that you
     * set this to a meaningful string to make it easier to identify your widget, and
     * where it is used.
     */
    name: string;
    /**
     * Query param: Direction to order widgets.
     */
    direction?: 'asc' | 'desc';
    /**
     * Query param: Field to order widgets by.
     */
    order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
    /**
     * Query param: Page number of paginated results.
     */
    page?: number;
    /**
     * Query param: Number of items per page.
     */
    per_page?: number;
    /**
     * Body param: If bot_fight_mode is set to `true`, Cloudflare issues
     * computationally expensive challenges in response to malicious bots (ENT only).
     */
    bot_fight_mode?: boolean;
    /**
     * Body param: If Turnstile is embedded on a Cloudflare site and the widget should
     * grant challenge clearance, this setting can determine the clearance level to be
     * set
     */
    clearance_level?: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
    /**
     * Body param: Do not show any Cloudflare branding on the widget (ENT only).
     */
    offlabel?: boolean;
    /**
     * Body param: Region where this widget can be used.
     */
    region?: 'world';
}
export interface WidgetUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param:
     */
    domains: Array<WidgetDomain>;
    /**
     * Body param: Widget Mode
     */
    mode: 'non-interactive' | 'invisible' | 'managed';
    /**
     * Body param: Human readable widget name. Not unique. Cloudflare suggests that you
     * set this to a meaningful string to make it easier to identify your widget, and
     * where it is used.
     */
    name: string;
    /**
     * Body param: If bot_fight_mode is set to `true`, Cloudflare issues
     * computationally expensive challenges in response to malicious bots (ENT only).
     */
    bot_fight_mode?: boolean;
    /**
     * Body param: If Turnstile is embedded on a Cloudflare site and the widget should
     * grant challenge clearance, this setting can determine the clearance level to be
     * set
     */
    clearance_level?: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
    /**
     * Body param: Do not show any Cloudflare branding on the widget (ENT only).
     */
    offlabel?: boolean;
}
export interface WidgetListParams extends V4PagePaginationArrayParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Query param: Direction to order widgets.
     */
    direction?: 'asc' | 'desc';
    /**
     * Query param: Field to order widgets by.
     */
    order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
}
export interface WidgetDeleteParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface WidgetGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface WidgetRotateSecretParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: If `invalidate_immediately` is set to `false`, the previous secret
     * will remain valid for two hours. Otherwise, the secret is immediately
     * invalidated, and requests using it will be rejected.
     */
    invalidate_immediately?: boolean;
}
export declare namespace Widgets {
    export import Widget = WidgetsAPI.Widget;
    export import WidgetDomain = WidgetsAPI.WidgetDomain;
    export import WidgetListResponse = WidgetsAPI.WidgetListResponse;
    export import WidgetListResponsesV4PagePaginationArray = WidgetsAPI.WidgetListResponsesV4PagePaginationArray;
    export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
    export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
    export import WidgetListParams = WidgetsAPI.WidgetListParams;
    export import WidgetDeleteParams = WidgetsAPI.WidgetDeleteParams;
    export import WidgetGetParams = WidgetsAPI.WidgetGetParams;
    export import WidgetRotateSecretParams = WidgetsAPI.WidgetRotateSecretParams;
}
//# sourceMappingURL=widgets.d.ts.map