cloudflare
Version:
The official TypeScript library for the Cloudflare API
284 lines (245 loc) • 8.25 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../core/resource';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';
export class BaseSettings extends APIResource {
static override readonly _key: readonly ['zeroTrust', 'devices', 'settings'] = Object.freeze([
'zeroTrust',
'devices',
'settings',
] as const);
/**
* Deprecated: use "PATCH /accounts/{account_id}/devices/settings" instead
*
* @deprecated
*/
update(params: SettingUpdateParams, options?: RequestOptions): APIPromise<DeviceSettings | null> {
const { account_id, ...body } = params;
return (
this._client.put(path`/accounts/${account_id}/devices/settings`, { body, ...options }) as APIPromise<{
result: DeviceSettings | null;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Resets the current device settings for a Zero Trust account.
*
* @example
* ```ts
* const deviceSettings =
* await client.zeroTrust.devices.settings.delete({
* account_id: '699d98642c564d2e855e9661899b7252',
* });
* ```
*/
delete(params: SettingDeleteParams, options?: RequestOptions): APIPromise<DeviceSettings | null> {
const { account_id } = params;
return (
this._client.delete(path`/accounts/${account_id}/devices/settings`, options) as APIPromise<{
result: DeviceSettings | null;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Updates the device settings for a Zero Trust account.
*
* @example
* ```ts
* const deviceSettings =
* await client.zeroTrust.devices.settings.edit({
* account_id: '699d98642c564d2e855e9661899b7252',
* });
* ```
*/
edit(params: SettingEditParams, options?: RequestOptions): APIPromise<DeviceSettings | null> {
const { account_id, ...body } = params;
return (
this._client.patch(path`/accounts/${account_id}/devices/settings`, { body, ...options }) as APIPromise<{
result: DeviceSettings | null;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Describes the current device settings for a Zero Trust account.
*
* @example
* ```ts
* const deviceSettings =
* await client.zeroTrust.devices.settings.get({
* account_id: '699d98642c564d2e855e9661899b7252',
* });
* ```
*/
get(params: SettingGetParams, options?: RequestOptions): APIPromise<DeviceSettings | null> {
const { account_id } = params;
return (
this._client.get(path`/accounts/${account_id}/devices/settings`, options) as APIPromise<{
result: DeviceSettings | null;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export class Settings extends BaseSettings {}
export interface DeviceSettings {
/**
* Sets the time limit, in seconds, that a user can use an override code to bypass
* WARP.
*/
disable_for_time?: number;
/**
* Controls whether the external emergency disconnect feature is enabled.
*/
external_emergency_signal_enabled?: boolean;
/**
* The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server
* certificate for the external_emergency_signal_url. If provided, the WARP client
* will use this value to verify the server's identity. The device will ignore any
* response if the server's certificate fingerprint does not exactly match this
* value.
*/
external_emergency_signal_fingerprint?: string;
/**
* The interval at which the WARP client fetches the emergency disconnect signal,
* formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds.
*/
external_emergency_signal_interval?: string;
/**
* The HTTPS URL from which to fetch the emergency disconnect signal. Must use
* HTTPS and have an IPv4 or IPv6 address as the host.
*/
external_emergency_signal_url?: string;
/**
* Enable gateway proxy filtering on TCP.
*/
gateway_proxy_enabled?: boolean;
/**
* Enable gateway proxy filtering on UDP.
*/
gateway_udp_proxy_enabled?: boolean;
/**
* Enable installation of cloudflare managed root certificate.
*/
root_certificate_installation_enabled?: boolean;
/**
* Enable using CGNAT virtual IPv4.
*/
use_zt_virtual_ip?: boolean;
}
export interface SettingUpdateParams {
/**
* Path param
*/
account_id: string;
/**
* Body param: Sets the time limit, in seconds, that a user can use an override
* code to bypass WARP.
*/
disable_for_time?: number;
/**
* Body param: Controls whether the external emergency disconnect feature is
* enabled.
*/
external_emergency_signal_enabled?: boolean;
/**
* Body param: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS
* server certificate for the external_emergency_signal_url. If provided, the WARP
* client will use this value to verify the server's identity. The device will
* ignore any response if the server's certificate fingerprint does not exactly
* match this value.
*/
external_emergency_signal_fingerprint?: string;
/**
* Body param: The interval at which the WARP client fetches the emergency
* disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h").
* Minimum 30 seconds.
*/
external_emergency_signal_interval?: string;
/**
* Body param: The HTTPS URL from which to fetch the emergency disconnect signal.
* Must use HTTPS and have an IPv4 or IPv6 address as the host.
*/
external_emergency_signal_url?: string;
/**
* Body param: Enable gateway proxy filtering on TCP.
*/
gateway_proxy_enabled?: boolean;
/**
* Body param: Enable gateway proxy filtering on UDP.
*/
gateway_udp_proxy_enabled?: boolean;
/**
* Body param: Enable installation of cloudflare managed root certificate.
*/
root_certificate_installation_enabled?: boolean;
/**
* Body param: Enable using CGNAT virtual IPv4.
*/
use_zt_virtual_ip?: boolean;
}
export interface SettingDeleteParams {
account_id: string;
}
export interface SettingEditParams {
/**
* Path param
*/
account_id: string;
/**
* Body param: Sets the time limit, in seconds, that a user can use an override
* code to bypass WARP.
*/
disable_for_time?: number;
/**
* Body param: Controls whether the external emergency disconnect feature is
* enabled.
*/
external_emergency_signal_enabled?: boolean;
/**
* Body param: The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS
* server certificate for the external_emergency_signal_url. If provided, the WARP
* client will use this value to verify the server's identity. The device will
* ignore any response if the server's certificate fingerprint does not exactly
* match this value.
*/
external_emergency_signal_fingerprint?: string;
/**
* Body param: The interval at which the WARP client fetches the emergency
* disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h").
* Minimum 30 seconds.
*/
external_emergency_signal_interval?: string;
/**
* Body param: The HTTPS URL from which to fetch the emergency disconnect signal.
* Must use HTTPS and have an IPv4 or IPv6 address as the host.
*/
external_emergency_signal_url?: string;
/**
* Body param: Enable gateway proxy filtering on TCP.
*/
gateway_proxy_enabled?: boolean;
/**
* Body param: Enable gateway proxy filtering on UDP.
*/
gateway_udp_proxy_enabled?: boolean;
/**
* Body param: Enable installation of cloudflare managed root certificate.
*/
root_certificate_installation_enabled?: boolean;
/**
* Body param: Enable using CGNAT virtual IPv4.
*/
use_zt_virtual_ip?: boolean;
}
export interface SettingGetParams {
account_id: string;
}
export declare namespace Settings {
export {
type DeviceSettings as DeviceSettings,
type SettingUpdateParams as SettingUpdateParams,
type SettingDeleteParams as SettingDeleteParams,
type SettingEditParams as SettingEditParams,
type SettingGetParams as SettingGetParams,
};
}