cloudflare
Version:
The official TypeScript library for the Cloudflare API
274 lines (245 loc) • 6.46 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../resource';
import * as Core from '../../../core';
import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../pagination';
export class CustomPages extends APIResource {
/**
* Create a custom page
*
* @example
* ```ts
* const customPageWithoutHTML =
* await client.zeroTrust.access.customPages.create({
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* custom_html:
* '<html><body><h1>Access Denied</h1></body></html>',
* name: 'name',
* type: 'identity_denied',
* });
* ```
*/
create(
params: CustomPageCreateParams,
options?: Core.RequestOptions,
): Core.APIPromise<CustomPageWithoutHTML> {
const { account_id, ...body } = params;
return (
this._client.post(`/accounts/${account_id}/access/custom_pages`, {
body,
...options,
}) as Core.APIPromise<{ result: CustomPageWithoutHTML }>
)._thenUnwrap((obj) => obj.result);
}
/**
* Update a custom page
*
* @example
* ```ts
* const customPageWithoutHTML =
* await client.zeroTrust.access.customPages.update(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* custom_html:
* '<html><body><h1>Access Denied</h1></body></html>',
* name: 'name',
* type: 'identity_denied',
* },
* );
* ```
*/
update(
customPageId: string,
params: CustomPageUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<CustomPageWithoutHTML> {
const { account_id, ...body } = params;
return (
this._client.put(`/accounts/${account_id}/access/custom_pages/${customPageId}`, {
body,
...options,
}) as Core.APIPromise<{ result: CustomPageWithoutHTML }>
)._thenUnwrap((obj) => obj.result);
}
/**
* List custom pages
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const customPageWithoutHTML of client.zeroTrust.access.customPages.list(
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* )) {
* // ...
* }
* ```
*/
list(
params: CustomPageListParams,
options?: Core.RequestOptions,
): Core.PagePromise<CustomPageWithoutHTMLsV4PagePaginationArray, CustomPageWithoutHTML> {
const { account_id, ...query } = params;
return this._client.getAPIList(
`/accounts/${account_id}/access/custom_pages`,
CustomPageWithoutHTMLsV4PagePaginationArray,
{ query, ...options },
);
}
/**
* Delete a custom page
*
* @example
* ```ts
* const customPage =
* await client.zeroTrust.access.customPages.delete(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
delete(
customPageId: string,
params: CustomPageDeleteParams,
options?: Core.RequestOptions,
): Core.APIPromise<CustomPageDeleteResponse> {
const { account_id } = params;
return (
this._client.delete(
`/accounts/${account_id}/access/custom_pages/${customPageId}`,
options,
) as Core.APIPromise<{ result: CustomPageDeleteResponse }>
)._thenUnwrap((obj) => obj.result);
}
/**
* Fetches a custom page and also returns its HTML.
*
* @example
* ```ts
* const customPage =
* await client.zeroTrust.access.customPages.get(
* 'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
* );
* ```
*/
get(
customPageId: string,
params: CustomPageGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<CustomPage> {
const { account_id } = params;
return (
this._client.get(
`/accounts/${account_id}/access/custom_pages/${customPageId}`,
options,
) as Core.APIPromise<{ result: CustomPage }>
)._thenUnwrap((obj) => obj.result);
}
}
export class CustomPageWithoutHTMLsV4PagePaginationArray extends V4PagePaginationArray<CustomPageWithoutHTML> {}
export interface CustomPage {
/**
* Custom page HTML.
*/
custom_html: string;
/**
* Custom page name.
*/
name: string;
/**
* Custom page type.
*/
type: 'identity_denied' | 'forbidden';
/**
* UUID.
*/
uid?: string;
}
export interface CustomPageWithoutHTML {
/**
* Custom page name.
*/
name: string;
/**
* Custom page type.
*/
type: 'identity_denied' | 'forbidden';
/**
* UUID.
*/
uid?: string;
}
export interface CustomPageDeleteResponse {
/**
* UUID.
*/
id?: string;
}
export interface CustomPageCreateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: Custom page HTML.
*/
custom_html: string;
/**
* Body param: Custom page name.
*/
name: string;
/**
* Body param: Custom page type.
*/
type: 'identity_denied' | 'forbidden';
}
export interface CustomPageUpdateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Body param: Custom page HTML.
*/
custom_html: string;
/**
* Body param: Custom page name.
*/
name: string;
/**
* Body param: Custom page type.
*/
type: 'identity_denied' | 'forbidden';
}
export interface CustomPageListParams extends V4PagePaginationArrayParams {
/**
* Path param: Identifier.
*/
account_id: string;
}
export interface CustomPageDeleteParams {
/**
* Identifier.
*/
account_id: string;
}
export interface CustomPageGetParams {
/**
* Identifier.
*/
account_id: string;
}
CustomPages.CustomPageWithoutHTMLsV4PagePaginationArray = CustomPageWithoutHTMLsV4PagePaginationArray;
export declare namespace CustomPages {
export {
type CustomPage as CustomPage,
type CustomPageWithoutHTML as CustomPageWithoutHTML,
type CustomPageDeleteResponse as CustomPageDeleteResponse,
CustomPageWithoutHTMLsV4PagePaginationArray as CustomPageWithoutHTMLsV4PagePaginationArray,
type CustomPageCreateParams as CustomPageCreateParams,
type CustomPageUpdateParams as CustomPageUpdateParams,
type CustomPageListParams as CustomPageListParams,
type CustomPageDeleteParams as CustomPageDeleteParams,
type CustomPageGetParams as CustomPageGetParams,
};
}