cloudflare
Version:
The official TypeScript library for the Cloudflare API
268 lines (242 loc) • 8.65 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 BaseFraud extends APIResource {
static override readonly _key: readonly ['fraud'] = Object.freeze(['fraud'] as const);
/**
* Update Fraud Detection settings for a zone.
*
* Notes on `username_expressions` behavior:
*
* - If omitted or set to null, expressions are not modified.
* - If provided as an empty array `[]`, all expressions will be cleared.
*
* @example
* ```ts
* const fraudSettings = await client.fraud.update({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* username_expressions: [],
* });
* ```
*/
update(params: FraudUpdateParams, options?: RequestOptions): APIPromise<FraudSettings> {
const { zone_id, ...body } = params;
return (
this._client.put(path`/zones/${zone_id}/fraud_detection/settings`, { body, ...options }) as APIPromise<{
result: FraudSettings;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieve Fraud Detection settings for a zone.
*
* @example
* ```ts
* const fraudSettings = await client.fraud.get({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
get(params: FraudGetParams, options?: RequestOptions): APIPromise<FraudSettings> {
const { zone_id } = params;
return (
this._client.get(path`/zones/${zone_id}/fraud_detection/settings`, options) as APIPromise<{
result: FraudSettings;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export class Fraud extends BaseFraud {}
export interface FraudSettings {
/**
* Configuration for classifying login authentication outcomes based on the origin
* response. Requires `user_profiles` to be enabled.
*
* - Success and failure criteria are independently updatable — sending only
* `success_criteria` leaves failure codes untouched, and vice versa.
* - Omit `authentication_settings` entirely to leave both unchanged.
* - Status codes must not overlap between success and failure criteria.
*/
authentication_settings?: FraudSettings.AuthenticationSettings;
/**
* Whether Fraud User Profiles is enabled for the zone.
*/
user_profiles?: 'enabled' | 'disabled';
/**
* List of expressions to detect usernames in write HTTP requests.
*
* - Maximum of 10 expressions.
* - Omit or set to null to leave unchanged on update.
* - Provide an empty array `[]` to clear all expressions on update.
* - Invalid expressions will result in a 10400 Bad Request with details in the
* `messages` array.
*/
username_expressions?: Array<string>;
}
export namespace FraudSettings {
/**
* Configuration for classifying login authentication outcomes based on the origin
* response. Requires `user_profiles` to be enabled.
*
* - Success and failure criteria are independently updatable — sending only
* `success_criteria` leaves failure codes untouched, and vice versa.
* - Omit `authentication_settings` entirely to leave both unchanged.
* - Status codes must not overlap between success and failure criteria.
*/
export interface AuthenticationSettings {
/**
* Criterion for identifying failed login responses.
*/
failure_criteria?: AuthenticationSettings.FailureCriteria;
/**
* Criterion for identifying successful login responses.
*/
success_criteria?: AuthenticationSettings.SuccessCriteria;
}
export namespace AuthenticationSettings {
/**
* Criterion for identifying failed login responses.
*/
export interface FailureCriteria {
/**
* The type of criterion. Currently only `status_code` is supported.
*/
kind: 'status_code';
/**
* HTTP status codes to match against the origin response.
*
* - Maximum of 10 codes per criterion.
* - Each code must be a valid HTTP status code (100-599).
* - Codes are deduplicated and sorted on save.
* - Omit to leave unchanged on update.
* - Provide an empty array `[]` to clear codes on update.
*/
status_codes?: Array<number>;
}
/**
* Criterion for identifying successful login responses.
*/
export interface SuccessCriteria {
/**
* The type of criterion. Currently only `status_code` is supported.
*/
kind: 'status_code';
/**
* HTTP status codes to match against the origin response.
*
* - Maximum of 10 codes per criterion.
* - Each code must be a valid HTTP status code (100-599).
* - Codes are deduplicated and sorted on save.
* - Omit to leave unchanged on update.
* - Provide an empty array `[]` to clear codes on update.
*/
status_codes?: Array<number>;
}
}
}
export interface FraudUpdateParams {
/**
* Path param: Identifier.
*/
zone_id: string;
/**
* Body param: Configuration for classifying login authentication outcomes based on
* the origin response. Requires `user_profiles` to be enabled.
*
* - Success and failure criteria are independently updatable — sending only
* `success_criteria` leaves failure codes untouched, and vice versa.
* - Omit `authentication_settings` entirely to leave both unchanged.
* - Status codes must not overlap between success and failure criteria.
*/
authentication_settings?: FraudUpdateParams.AuthenticationSettings;
/**
* Body param: Whether Fraud User Profiles is enabled for the zone.
*/
user_profiles?: 'enabled' | 'disabled';
/**
* Body param: List of expressions to detect usernames in write HTTP requests.
*
* - Maximum of 10 expressions.
* - Omit or set to null to leave unchanged on update.
* - Provide an empty array `[]` to clear all expressions on update.
* - Invalid expressions will result in a 10400 Bad Request with details in the
* `messages` array.
*/
username_expressions?: Array<string>;
}
export namespace FraudUpdateParams {
/**
* Configuration for classifying login authentication outcomes based on the origin
* response. Requires `user_profiles` to be enabled.
*
* - Success and failure criteria are independently updatable — sending only
* `success_criteria` leaves failure codes untouched, and vice versa.
* - Omit `authentication_settings` entirely to leave both unchanged.
* - Status codes must not overlap between success and failure criteria.
*/
export interface AuthenticationSettings {
/**
* Criterion for identifying failed login responses.
*/
failure_criteria?: AuthenticationSettings.FailureCriteria;
/**
* Criterion for identifying successful login responses.
*/
success_criteria?: AuthenticationSettings.SuccessCriteria;
}
export namespace AuthenticationSettings {
/**
* Criterion for identifying failed login responses.
*/
export interface FailureCriteria {
/**
* The type of criterion. Currently only `status_code` is supported.
*/
kind: 'status_code';
/**
* HTTP status codes to match against the origin response.
*
* - Maximum of 10 codes per criterion.
* - Each code must be a valid HTTP status code (100-599).
* - Codes are deduplicated and sorted on save.
* - Omit to leave unchanged on update.
* - Provide an empty array `[]` to clear codes on update.
*/
status_codes?: Array<number>;
}
/**
* Criterion for identifying successful login responses.
*/
export interface SuccessCriteria {
/**
* The type of criterion. Currently only `status_code` is supported.
*/
kind: 'status_code';
/**
* HTTP status codes to match against the origin response.
*
* - Maximum of 10 codes per criterion.
* - Each code must be a valid HTTP status code (100-599).
* - Codes are deduplicated and sorted on save.
* - Omit to leave unchanged on update.
* - Provide an empty array `[]` to clear codes on update.
*/
status_codes?: Array<number>;
}
}
}
export interface FraudGetParams {
/**
* Identifier.
*/
zone_id: string;
}
export declare namespace Fraud {
export {
type FraudSettings as FraudSettings,
type FraudUpdateParams as FraudUpdateParams,
type FraudGetParams as FraudGetParams,
};
}