cloudflare 6.0.0 → 6.2.0

package/src/resources/ddos-protection/advanced-tcp-protection/syn-protection/rules/items.ts

@@ -0,0 +1,287 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../resource';
+import * as Core from '../../../../../core';
+
+export class Items extends APIResource {
+  /**
+   * Delete a SYN Protection rule specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const item =
+   *   await client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.delete(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  delete(
+    ruleId: string,
+    params: ItemDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ItemDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(
+      `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/${ruleId}`,
+      options,
+    );
+  }
+
+  /**
+   * Update a SYN Protection rule specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.edit(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  edit(
+    ruleId: string,
+    params: ItemEditParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ItemEditResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.patch(
+        `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/${ruleId}`,
+        { body, ...options },
+      ) as Core.APIPromise<{ result: ItemEditResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Get a SYN Protection rule specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const item =
+   *   await client.DDoSProtection.advancedTCPProtection.synProtection.rules.items.get(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    ruleId: string,
+    params: ItemGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ItemGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/${ruleId}`,
+        options,
+      ) as Core.APIPromise<{ result: ItemGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface ItemDeleteResponse {
+  errors: Array<ItemDeleteResponse.Error>;
+
+  messages: Array<ItemDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace ItemDeleteResponse {
+  export interface Error {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Error.Source;
+  }
+
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+}
+
+export interface ItemEditResponse {
+  /**
+   * The unique ID of the SYN Protection rule.
+   */
+  id: string;
+
+  /**
+   * The burst sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  burst_sensitivity: string;
+
+  /**
+   * The creation timestamp of the SYN Protection rule.
+   */
+  created_on: string;
+
+  /**
+   * The type of mitigation for SYN Protection. Must be one of 'challenge' or
+   * 'retransmit'.
+   */
+  mitigation_type: string;
+
+  /**
+   * The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the SYN Protection rule.
+   */
+  modified_on: string;
+
+  /**
+   * The name of the SYN Protection rule. Value is relative to the 'scope' setting.
+   * For 'global' scope, name should be 'global'. For either the 'region' or
+   * 'datacenter' scope, name should be the actual name of the region or datacenter,
+   * e.g., 'wnam' or 'lax'.
+   */
+  name: string;
+
+  /**
+   * The rate sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  rate_sensitivity: string;
+
+  /**
+   * The scope for the SYN Protection rule. Must be one of 'global', 'region', or
+   * 'datacenter'.
+   */
+  scope: string;
+}
+
+export interface ItemGetResponse {
+  /**
+   * The unique ID of the SYN Protection rule.
+   */
+  id: string;
+
+  /**
+   * The burst sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  burst_sensitivity: string;
+
+  /**
+   * The creation timestamp of the SYN Protection rule.
+   */
+  created_on: string;
+
+  /**
+   * The type of mitigation for SYN Protection. Must be one of 'challenge' or
+   * 'retransmit'.
+   */
+  mitigation_type: string;
+
+  /**
+   * The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the SYN Protection rule.
+   */
+  modified_on: string;
+
+  /**
+   * The name of the SYN Protection rule. Value is relative to the 'scope' setting.
+   * For 'global' scope, name should be 'global'. For either the 'region' or
+   * 'datacenter' scope, name should be the actual name of the region or datacenter,
+   * e.g., 'wnam' or 'lax'.
+   */
+  name: string;
+
+  /**
+   * The rate sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  rate_sensitivity: string;
+
+  /**
+   * The scope for the SYN Protection rule. Must be one of 'global', 'region', or
+   * 'datacenter'.
+   */
+  scope: string;
+}
+
+export interface ItemDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface ItemEditParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The new burst sensitivity. Optional. Must be one of 'low', 'medium',
+   * 'high'.
+   */
+  burst_sensitivity?: string;
+
+  /**
+   * Body param: The new mitigation type. Optional. Must be one of 'challenge' or
+   * 'retransmit'.
+   */
+  mitigation_type?: string;
+
+  /**
+   * Body param: The new mode for SYN Protection. Optional. Must be one of 'enabled',
+   * 'disabled', 'monitoring'.
+   */
+  mode?: string;
+
+  /**
+   * Body param: The new rate sensitivity. Optional. Must be one of 'low', 'medium',
+   * 'high'.
+   */
+  rate_sensitivity?: string;
+}
+
+export interface ItemGetParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export declare namespace Items {
+  export {
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemEditResponse as ItemEditResponse,
+    type ItemGetResponse as ItemGetResponse,
+    type ItemDeleteParams as ItemDeleteParams,
+    type ItemEditParams as ItemEditParams,
+    type ItemGetParams as ItemGetParams,
+  };
+}

package/src/resources/ddos-protection/advanced-tcp-protection/syn-protection/rules/rules.ts

@@ -0,0 +1,337 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../resource';
+import * as Core from '../../../../../core';
+import * as ItemsAPI from './items';
+import {
+  ItemDeleteParams,
+  ItemDeleteResponse,
+  ItemEditParams,
+  ItemEditResponse,
+  ItemGetParams,
+  ItemGetResponse,
+  Items,
+} from './items';
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../../../../pagination';
+
+export class Rules extends APIResource {
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
+
+  /**
+   * Create a SYN Protection rule for an account.
+   *
+   * @example
+   * ```ts
+   * const rule =
+   *   await client.DDoSProtection.advancedTCPProtection.synProtection.rules.create(
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       burst_sensitivity: 'burst_sensitivity',
+   *       mode: 'mode',
+   *       name: 'name',
+   *       rate_sensitivity: 'rate_sensitivity',
+   *       scope: 'scope',
+   *     },
+   *   );
+   * ```
+   */
+  create(params: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(
+        `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules`,
+        { body, ...options },
+      ) as Core.APIPromise<{ result: RuleCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * List all SYN Protection rules for an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const ruleListResponse of client.DDoSProtection.advancedTCPProtection.synProtection.rules.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: RuleListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RuleListResponsesV4PagePaginationArray, RuleListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules`,
+      RuleListResponsesV4PagePaginationArray,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete all SYN Protection rules for an account.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.DDoSProtection.advancedTCPProtection.synProtection.rules.bulkDelete(
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  bulkDelete(
+    params: RuleBulkDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleBulkDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(
+      `/accounts/${account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules`,
+      options,
+    );
+  }
+}
+
+export class RuleListResponsesV4PagePaginationArray extends V4PagePaginationArray<RuleListResponse> {}
+
+export interface RuleCreateResponse {
+  /**
+   * The unique ID of the SYN Protection rule.
+   */
+  id: string;
+
+  /**
+   * The burst sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  burst_sensitivity: string;
+
+  /**
+   * The creation timestamp of the SYN Protection rule.
+   */
+  created_on: string;
+
+  /**
+   * The type of mitigation for SYN Protection. Must be one of 'challenge' or
+   * 'retransmit'.
+   */
+  mitigation_type: string;
+
+  /**
+   * The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the SYN Protection rule.
+   */
+  modified_on: string;
+
+  /**
+   * The name of the SYN Protection rule. Value is relative to the 'scope' setting.
+   * For 'global' scope, name should be 'global'. For either the 'region' or
+   * 'datacenter' scope, name should be the actual name of the region or datacenter,
+   * e.g., 'wnam' or 'lax'.
+   */
+  name: string;
+
+  /**
+   * The rate sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  rate_sensitivity: string;
+
+  /**
+   * The scope for the SYN Protection rule. Must be one of 'global', 'region', or
+   * 'datacenter'.
+   */
+  scope: string;
+}
+
+export interface RuleListResponse {
+  /**
+   * The unique ID of the SYN Protection rule.
+   */
+  id: string;
+
+  /**
+   * The burst sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  burst_sensitivity: string;
+
+  /**
+   * The creation timestamp of the SYN Protection rule.
+   */
+  created_on: string;
+
+  /**
+   * The type of mitigation for SYN Protection. Must be one of 'challenge' or
+   * 'retransmit'.
+   */
+  mitigation_type: string;
+
+  /**
+   * The mode for SYN Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the SYN Protection rule.
+   */
+  modified_on: string;
+
+  /**
+   * The name of the SYN Protection rule. Value is relative to the 'scope' setting.
+   * For 'global' scope, name should be 'global'. For either the 'region' or
+   * 'datacenter' scope, name should be the actual name of the region or datacenter,
+   * e.g., 'wnam' or 'lax'.
+   */
+  name: string;
+
+  /**
+   * The rate sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  rate_sensitivity: string;
+
+  /**
+   * The scope for the SYN Protection rule. Must be one of 'global', 'region', or
+   * 'datacenter'.
+   */
+  scope: string;
+}
+
+export interface RuleBulkDeleteResponse {
+  errors: Array<RuleBulkDeleteResponse.Error>;
+
+  messages: Array<RuleBulkDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace RuleBulkDeleteResponse {
+  export interface Error {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Error.Source;
+  }
+
+  export namespace Error {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+
+  export interface Message {
+    code: number;
+
+    message: string;
+
+    documentation_url?: string;
+
+    source?: Message.Source;
+  }
+
+  export namespace Message {
+    export interface Source {
+      pointer?: string;
+    }
+  }
+}
+
+export interface RuleCreateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The burst sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  burst_sensitivity: string;
+
+  /**
+   * Body param: The mode for SYN Protection. Must be one of 'enabled', 'disabled',
+   * 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * Body param: The name of the SYN Protection rule. Value is relative to the
+   * 'scope' setting. For 'global' scope, name should be 'global'. For either the
+   * 'region' or 'datacenter' scope, name should be the actual name of the region or
+   * datacenter, e.g., 'wnam' or 'lax'.
+   */
+  name: string;
+
+  /**
+   * Body param: The rate sensitivity. Must be one of 'low', 'medium', 'high'.
+   */
+  rate_sensitivity: string;
+
+  /**
+   * Body param: The scope for the SYN Protection rule. Must be one of 'global',
+   * 'region', or 'datacenter'.
+   */
+  scope: string;
+
+  /**
+   * Body param: The type of mitigation. Must be one of 'challenge' or 'retransmit'.
+   * Optional. Defaults to 'challenge'.
+   */
+  mitigation_type?: string;
+}
+
+export interface RuleListParams extends V4PagePaginationArrayParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Query param: The direction of ordering (ASC or DESC). Defaults to 'ASC'.
+   */
+  direction?: string;
+
+  /**
+   * Query param: The field to order by. Defaults to 'prefix'.
+   */
+  order?: string;
+}
+
+export interface RuleBulkDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+Rules.RuleListResponsesV4PagePaginationArray = RuleListResponsesV4PagePaginationArray;
+Rules.Items = Items;
+
+export declare namespace Rules {
+  export {
+    type RuleCreateResponse as RuleCreateResponse,
+    type RuleListResponse as RuleListResponse,
+    type RuleBulkDeleteResponse as RuleBulkDeleteResponse,
+    RuleListResponsesV4PagePaginationArray as RuleListResponsesV4PagePaginationArray,
+    type RuleCreateParams as RuleCreateParams,
+    type RuleListParams as RuleListParams,
+    type RuleBulkDeleteParams as RuleBulkDeleteParams,
+  };
+
+  export {
+    Items as Items,
+    type ItemDeleteResponse as ItemDeleteResponse,
+    type ItemEditResponse as ItemEditResponse,
+    type ItemGetResponse as ItemGetResponse,
+    type ItemDeleteParams as ItemDeleteParams,
+    type ItemEditParams as ItemEditParams,
+    type ItemGetParams as ItemGetParams,
+  };
+}

package/src/resources/ddos-protection/advanced-tcp-protection/syn-protection/rules.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './rules/index';

package/src/resources/ddos-protection/advanced-tcp-protection/syn-protection/syn-protection.ts

@@ -0,0 +1,59 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../resource';
+import * as FiltersAPI from './filters/filters';
+import {
+  FilterBulkDeleteParams,
+  FilterBulkDeleteResponse,
+  FilterCreateParams,
+  FilterCreateResponse,
+  FilterListParams,
+  FilterListResponse,
+  FilterListResponsesV4PagePaginationArray,
+  Filters,
+} from './filters/filters';
+import * as RulesAPI from './rules/rules';
+import {
+  RuleBulkDeleteParams,
+  RuleBulkDeleteResponse,
+  RuleCreateParams,
+  RuleCreateResponse,
+  RuleListParams,
+  RuleListResponse,
+  RuleListResponsesV4PagePaginationArray,
+  Rules,
+} from './rules/rules';
+
+export class SynProtection extends APIResource {
+  filters: FiltersAPI.Filters = new FiltersAPI.Filters(this._client);
+  rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
+}
+
+SynProtection.Filters = Filters;
+SynProtection.FilterListResponsesV4PagePaginationArray = FilterListResponsesV4PagePaginationArray;
+SynProtection.Rules = Rules;
+SynProtection.RuleListResponsesV4PagePaginationArray = RuleListResponsesV4PagePaginationArray;
+
+export declare namespace SynProtection {
+  export {
+    Filters as Filters,
+    type FilterCreateResponse as FilterCreateResponse,
+    type FilterListResponse as FilterListResponse,
+    type FilterBulkDeleteResponse as FilterBulkDeleteResponse,
+    FilterListResponsesV4PagePaginationArray as FilterListResponsesV4PagePaginationArray,
+    type FilterCreateParams as FilterCreateParams,
+    type FilterListParams as FilterListParams,
+    type FilterBulkDeleteParams as FilterBulkDeleteParams,
+  };
+
+  export {
+    Rules as Rules,
+    type RuleCreateResponse as RuleCreateResponse,
+    type RuleListResponse as RuleListResponse,
+    type RuleBulkDeleteResponse as RuleBulkDeleteResponse,
+    RuleListResponsesV4PagePaginationArray as RuleListResponsesV4PagePaginationArray,
+    type RuleCreateParams as RuleCreateParams,
+    type RuleListParams as RuleListParams,
+    type RuleBulkDeleteParams as RuleBulkDeleteParams,
+  };
+}

package/src/resources/ddos-protection/advanced-tcp-protection/syn-protection.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './syn-protection/index';