cloudflare
Version:
The official TypeScript library for the Cloudflare API
68 lines • 2.23 kB
text/typescript
import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseSettings extends APIResource {
static readonly _key: readonly ['originTLSClientAuth', 'settings'];
/**
* Enable or disable zone-level authenticated origin pulls. 'enabled' should be set
* true either before/after the certificate is uploaded to see the certificate in
* use.
*
* @example
* ```ts
* const setting =
* await client.originTLSClientAuth.settings.update({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* enabled: true,
* });
* ```
*/
update(params: SettingUpdateParams, options?: RequestOptions): APIPromise<SettingUpdateResponse>;
/**
* Get whether zone-level authenticated origin pulls is enabled or not. It is false
* by default.
*
* @example
* ```ts
* const setting =
* await client.originTLSClientAuth.settings.get({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
get(params: SettingGetParams, options?: RequestOptions): APIPromise<SettingGetResponse>;
}
export declare class Settings extends BaseSettings {
}
export interface SettingUpdateResponse {
/**
* Indicates whether zone-level authenticated origin pulls is enabled.
*/
enabled?: boolean;
}
export interface SettingGetResponse {
/**
* Indicates whether zone-level authenticated origin pulls is enabled.
*/
enabled?: boolean;
}
export interface SettingUpdateParams {
/**
* Path param: Identifier.
*/
zone_id: string;
/**
* Body param: Indicates whether zone-level authenticated origin pulls is enabled.
*/
enabled: boolean;
}
export interface SettingGetParams {
/**
* Identifier.
*/
zone_id: string;
}
export declare namespace Settings {
export { type SettingUpdateResponse as SettingUpdateResponse, type SettingGetResponse as SettingGetResponse, type SettingUpdateParams as SettingUpdateParams, type SettingGetParams as SettingGetParams, };
}
//# sourceMappingURL=settings.d.mts.map