cloudflare/resources/zero-trust/access/custom-pages.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as CustomPagesAPI from 'cloudflare/resources/zero-trust/access/custom-pages';
import { SinglePage } from 'cloudflare/pagination';
export declare class CustomPages extends APIResource {
    /**
     * Create a custom page
     */
    create(identifier: string, body: CustomPageCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomPageWithoutHTML>;
    /**
     * Update a custom page
     */
    update(identifier: string, uuid: string, body: CustomPageUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CustomPageWithoutHTML>;
    /**
     * List custom pages
     */
    list(identifier: string, options?: Core.RequestOptions): Core.PagePromise<CustomPageWithoutHTMLsSinglePage, CustomPageWithoutHTML>;
    /**
     * Delete a custom page
     */
    delete(identifier: string, uuid: string, options?: Core.RequestOptions): Core.APIPromise<CustomPageDeleteResponse>;
    /**
     * Fetches a custom page and also returns its HTML.
     */
    get(identifier: string, uuid: string, options?: Core.RequestOptions): Core.APIPromise<CustomPage>;
}
export declare class CustomPageWithoutHTMLsSinglePage extends SinglePage<CustomPageWithoutHTML> {
}
export interface CustomPage {
    /**
     * Custom page HTML.
     */
    custom_html: string;
    /**
     * Custom page name.
     */
    name: string;
    /**
     * Custom page type.
     */
    type: 'identity_denied' | 'forbidden';
    /**
     * Number of apps the custom page is assigned to.
     */
    app_count?: number;
    created_at?: string;
    /**
     * UUID
     */
    uid?: string;
    updated_at?: string;
}
export interface CustomPageWithoutHTML {
    /**
     * Custom page name.
     */
    name: string;
    /**
     * Custom page type.
     */
    type: 'identity_denied' | 'forbidden';
    /**
     * Number of apps the custom page is assigned to.
     */
    app_count?: number;
    created_at?: string;
    /**
     * UUID
     */
    uid?: string;
    updated_at?: string;
}
export interface CustomPageDeleteResponse {
    /**
     * UUID
     */
    id?: string;
}
export interface CustomPageCreateParams {
    /**
     * Custom page HTML.
     */
    custom_html: string;
    /**
     * Custom page name.
     */
    name: string;
    /**
     * Custom page type.
     */
    type: 'identity_denied' | 'forbidden';
    /**
     * Number of apps the custom page is assigned to.
     */
    app_count?: number;
}
export interface CustomPageUpdateParams {
    /**
     * Custom page HTML.
     */
    custom_html: string;
    /**
     * Custom page name.
     */
    name: string;
    /**
     * Custom page type.
     */
    type: 'identity_denied' | 'forbidden';
    /**
     * Number of apps the custom page is assigned to.
     */
    app_count?: number;
}
export declare namespace CustomPages {
    export import CustomPage = CustomPagesAPI.CustomPage;
    export import CustomPageWithoutHTML = CustomPagesAPI.CustomPageWithoutHTML;
    export import CustomPageDeleteResponse = CustomPagesAPI.CustomPageDeleteResponse;
    export import CustomPageWithoutHTMLsSinglePage = CustomPagesAPI.CustomPageWithoutHTMLsSinglePage;
    export import CustomPageCreateParams = CustomPagesAPI.CustomPageCreateParams;
    export import CustomPageUpdateParams = CustomPagesAPI.CustomPageUpdateParams;
}
//# sourceMappingURL=custom-pages.d.ts.map