cloudflare 6.0.0 → 6.2.0

package/src/resources/ddos-protection/advanced-tcp-protection/tcp-flow-protection/filters/filters.ts

@@ -0,0 +1,266 @@
+// 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 Filters extends APIResource {
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
+
+  /**
+   * Create a TCP Flow Protection filter for an account.
+   *
+   * @example
+   * ```ts
+   * const filter =
+   *   await client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.create(
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       expression:
+   *         'ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }',
+   *       mode: 'mode',
+   *     },
+   *   );
+   * ```
+   */
+  create(params: FilterCreateParams, options?: Core.RequestOptions): Core.APIPromise<FilterCreateResponse> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(
+        `/accounts/${account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters`,
+        { body, ...options },
+      ) as Core.APIPromise<{ result: FilterCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * List all TCP Flow Protection filters for an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const filterListResponse of client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: FilterListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FilterListResponsesV4PagePaginationArray, FilterListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters`,
+      FilterListResponsesV4PagePaginationArray,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete all TCP Flow Protection filters for an account.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.bulkDelete(
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  bulkDelete(
+    params: FilterBulkDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<FilterBulkDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(
+      `/accounts/${account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters`,
+      options,
+    );
+  }
+}
+
+export class FilterListResponsesV4PagePaginationArray extends V4PagePaginationArray<FilterListResponse> {}
+
+export interface FilterCreateResponse {
+  /**
+   * The unique ID of the expression filter.
+   */
+  id: string;
+
+  /**
+   * The creation timestamp of the expression filter.
+   */
+  created_on: string;
+
+  /**
+   * The filter expression.
+   */
+  expression: string;
+
+  /**
+   * The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the expression filter.
+   */
+  modified_on: string;
+}
+
+export interface FilterListResponse {
+  /**
+   * The unique ID of the expression filter.
+   */
+  id: string;
+
+  /**
+   * The creation timestamp of the expression filter.
+   */
+  created_on: string;
+
+  /**
+   * The filter expression.
+   */
+  expression: string;
+
+  /**
+   * The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the expression filter.
+   */
+  modified_on: string;
+}
+
+export interface FilterBulkDeleteResponse {
+  errors: Array<FilterBulkDeleteResponse.Error>;
+
+  messages: Array<FilterBulkDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful.
+   */
+  success: true;
+}
+
+export namespace FilterBulkDeleteResponse {
+  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 FilterCreateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The filter expression.
+   */
+  expression: string;
+
+  /**
+   * Body param: The filter's mode. Must be one of 'enabled', 'disabled',
+   * 'monitoring'.
+   */
+  mode: string;
+}
+
+export interface FilterListParams 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 mode of the filters to get. Optional. Valid values: 'enabled',
+   * 'disabled', 'monitoring'.
+   */
+  mode?: string;
+
+  /**
+   * Query param: The field to order by. Defaults to 'prefix'.
+   */
+  order?: string;
+}
+
+export interface FilterBulkDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+Filters.FilterListResponsesV4PagePaginationArray = FilterListResponsesV4PagePaginationArray;
+Filters.Items = Items;
+
+export declare namespace Filters {
+  export {
+    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 {
+    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/tcp-flow-protection/filters/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  FilterListResponsesV4PagePaginationArray,
+  Filters,
+  type FilterCreateResponse,
+  type FilterListResponse,
+  type FilterBulkDeleteResponse,
+  type FilterCreateParams,
+  type FilterListParams,
+  type FilterBulkDeleteParams,
+} from './filters';
+export {
+  Items,
+  type ItemDeleteResponse,
+  type ItemEditResponse,
+  type ItemGetResponse,
+  type ItemDeleteParams,
+  type ItemEditParams,
+  type ItemGetParams,
+} from './items';

package/src/resources/ddos-protection/advanced-tcp-protection/tcp-flow-protection/filters/items.ts

@@ -0,0 +1,224 @@
+// 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 TCP Flow Protection filter specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const item =
+   *   await client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.delete(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  delete(
+    filterId: 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/tcp_flow_protection/filters/${filterId}`,
+      options,
+    );
+  }
+
+  /**
+   * Update a TCP Flow Protection filter specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.edit(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  edit(
+    filterId: 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/tcp_flow_protection/filters/${filterId}`,
+        { body, ...options },
+      ) as Core.APIPromise<{ result: ItemEditResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Get a TCP Flow Protection filter specified by the given UUID.
+   *
+   * @example
+   * ```ts
+   * const item =
+   *   await client.DDoSProtection.advancedTCPProtection.tcpFlowProtection.filters.items.get(
+   *     'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    filterId: 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/tcp_flow_protection/filters/${filterId}`,
+        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 expression filter.
+   */
+  id: string;
+
+  /**
+   * The creation timestamp of the expression filter.
+   */
+  created_on: string;
+
+  /**
+   * The filter expression.
+   */
+  expression: string;
+
+  /**
+   * The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the expression filter.
+   */
+  modified_on: string;
+}
+
+export interface ItemGetResponse {
+  /**
+   * The unique ID of the expression filter.
+   */
+  id: string;
+
+  /**
+   * The creation timestamp of the expression filter.
+   */
+  created_on: string;
+
+  /**
+   * The filter expression.
+   */
+  expression: string;
+
+  /**
+   * The filter's mode. Must be one of 'enabled', 'disabled', 'monitoring'.
+   */
+  mode: string;
+
+  /**
+   * The last modification timestamp of the expression filter.
+   */
+  modified_on: string;
+}
+
+export interface ItemDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface ItemEditParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The new filter expression. Optional.
+   */
+  expression?: string;
+
+  /**
+   * Body param: The new mode for the filter. Optional. Must be one of 'enabled',
+   * 'disabled', 'monitoring'.
+   */
+  mode?: 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/tcp-flow-protection/filters.ts

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

package/src/resources/ddos-protection/advanced-tcp-protection/tcp-flow-protection/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  FilterListResponsesV4PagePaginationArray,
+  Filters,
+  type FilterCreateResponse,
+  type FilterListResponse,
+  type FilterBulkDeleteResponse,
+  type FilterCreateParams,
+  type FilterListParams,
+  type FilterBulkDeleteParams,
+} from './filters/index';
+export {
+  RuleListResponsesV4PagePaginationArray,
+  Rules,
+  type RuleCreateResponse,
+  type RuleListResponse,
+  type RuleBulkDeleteResponse,
+  type RuleCreateParams,
+  type RuleListParams,
+  type RuleBulkDeleteParams,
+} from './rules/index';
+export { TCPFlowProtection } from './tcp-flow-protection';

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

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Items,
+  type ItemDeleteResponse,
+  type ItemEditResponse,
+  type ItemGetResponse,
+  type ItemDeleteParams,
+  type ItemEditParams,
+  type ItemGetParams,
+} from './items';
+export {
+  RuleListResponsesV4PagePaginationArray,
+  Rules,
+  type RuleCreateResponse,
+  type RuleListResponse,
+  type RuleBulkDeleteResponse,
+  type RuleCreateParams,
+  type RuleListParams,
+  type RuleBulkDeleteParams,
+} from './rules';