cloudflare 3.1.0 → 3.2.0

package/src/resources/rulesets/phases/phases.ts

@@ -6,6 +6,7 @@ import { isRequestOptions } from "../../../core";
 import { CloudflareError } from "../../../error";
 import * as PhasesAPI from "./phases";
 import * as RulesAPI from "../rules";
+import * as RulesetsAPI from "../rulesets";
 import * as VersionsAPI from "./versions";
 
 export class Phases extends APIResource {
@@ -15,30 +16,7 @@ export class Phases extends APIResource {
    * Updates an account or zone entry point ruleset, creating a new version.
    */
   update(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     params: PhaseUpdateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PhaseUpdateResponse> {
@@ -72,85 +50,13 @@ export class Phases extends APIResource {
    * given phase.
    */
   get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     params?: PhaseGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PhaseGetResponse>;
+  get(rulesetPhase: RulesetsAPI.PhaseParam, options?: Core.RequestOptions): Core.APIPromise<PhaseGetResponse>;
   get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PhaseGetResponse>;
-  get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     params: PhaseGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<PhaseGetResponse> {
@@ -195,7 +101,7 @@ export interface PhaseUpdateResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -210,30 +116,7 @@ export interface PhaseUpdateResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.
@@ -279,7 +162,7 @@ export interface PhaseGetResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -294,30 +177,7 @@ export interface PhaseGetResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.
@@ -356,21 +216,21 @@ export interface PhaseUpdateParams {
    * Body param: The list of rules in the ruleset.
    */
   rules: Array<
-    | RulesAPI.BlockRule
-    | RulesAPI.ChallengeRule
-    | RulesAPI.CompressResponseRule
-    | RulesAPI.ExecuteRule
-    | RulesAPI.JSChallengeRule
-    | RulesAPI.LogRule
-    | RulesAPI.ManagedChallengeRule
-    | RulesAPI.RedirectRule
-    | RulesAPI.RewriteRule
-    | RulesAPI.RouteRule
-    | RulesAPI.ScoreRule
-    | RulesAPI.ServeErrorRule
-    | RulesAPI.SetConfigRule
-    | RulesAPI.SkipRule
-    | RulesAPI.SetCacheSettingsRule
+    | RulesAPI.BlockRuleParam
+    | RulesAPI.ChallengeRuleParam
+    | RulesAPI.CompressResponseRuleParam
+    | RulesAPI.ExecuteRuleParam
+    | RulesAPI.JSChallengeRuleParam
+    | RulesAPI.LogRuleParam
+    | RulesAPI.ManagedChallengeRuleParam
+    | RulesAPI.RedirectRuleParam
+    | RulesAPI.RewriteRuleParam
+    | RulesAPI.RouteRuleParam
+    | RulesAPI.ScoreRuleParam
+    | RulesAPI.ServeErrorRuleParam
+    | RulesAPI.SetConfigRuleParam
+    | RulesAPI.SkipRuleParam
+    | RulesAPI.SetCacheSettingsRuleParam
   >;
 
   /**
@@ -393,7 +253,7 @@ export interface PhaseUpdateParams {
   /**
    * Body param: The kind of the ruleset.
    */
-  kind?: 'managed' | 'custom' | 'root' | 'zone';
+  kind?: RulesetsAPI.KindParam;
 
   /**
    * Body param: The human-readable name of the ruleset.
@@ -403,30 +263,7 @@ export interface PhaseUpdateParams {
   /**
    * Body param: The phase of the ruleset.
    */
-  phase?:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase?: RulesetsAPI.PhaseParam;
 }
 
 export interface PhaseGetParams {

package/src/resources/rulesets/phases/versions.ts

@@ -14,85 +14,16 @@ export class Versions extends APIResource {
    * Fetches the versions of an account or zone entry point ruleset.
    */
   list(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     params?: VersionListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset>;
   list(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     options?: Core.RequestOptions,
   ): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset>;
   list(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     params: VersionListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset> {
@@ -127,87 +58,18 @@ export class Versions extends APIResource {
    * Fetches a specific version of an account or zone entry point ruleset.
    */
   get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     rulesetVersion: string,
     params?: VersionGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<VersionGetResponse>;
   get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     rulesetVersion: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<VersionGetResponse>;
   get(
-    rulesetPhase:
-      | 'ddos_l4'
-      | 'ddos_l7'
-      | 'http_config_settings'
-      | 'http_custom_errors'
-      | 'http_log_custom_fields'
-      | 'http_ratelimit'
-      | 'http_request_cache_settings'
-      | 'http_request_dynamic_redirect'
-      | 'http_request_firewall_custom'
-      | 'http_request_firewall_managed'
-      | 'http_request_late_transform'
-      | 'http_request_origin'
-      | 'http_request_redirect'
-      | 'http_request_sanitize'
-      | 'http_request_sbfm'
-      | 'http_request_select_configuration'
-      | 'http_request_transform'
-      | 'http_response_compression'
-      | 'http_response_firewall_managed'
-      | 'http_response_headers_transform'
-      | 'magic_transit'
-      | 'magic_transit_ids_managed'
-      | 'magic_transit_managed',
+    rulesetPhase: RulesetsAPI.PhaseParam,
     rulesetVersion: string,
     params: VersionGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
@@ -253,7 +115,7 @@ export interface VersionGetResponse {
   /**
    * The kind of the ruleset.
    */
-  kind: 'managed' | 'custom' | 'root' | 'zone';
+  kind: RulesetsAPI.Kind;
 
   /**
    * The timestamp of when the ruleset was last modified.
@@ -268,30 +130,7 @@ export interface VersionGetResponse {
   /**
    * The phase of the ruleset.
    */
-  phase:
-    | 'ddos_l4'
-    | 'ddos_l7'
-    | 'http_config_settings'
-    | 'http_custom_errors'
-    | 'http_log_custom_fields'
-    | 'http_ratelimit'
-    | 'http_request_cache_settings'
-    | 'http_request_dynamic_redirect'
-    | 'http_request_firewall_custom'
-    | 'http_request_firewall_managed'
-    | 'http_request_late_transform'
-    | 'http_request_origin'
-    | 'http_request_redirect'
-    | 'http_request_sanitize'
-    | 'http_request_sbfm'
-    | 'http_request_select_configuration'
-    | 'http_request_transform'
-    | 'http_response_compression'
-    | 'http_response_firewall_managed'
-    | 'http_response_headers_transform'
-    | 'magic_transit'
-    | 'magic_transit_ids_managed'
-    | 'magic_transit_managed';
+  phase: RulesetsAPI.Phase;
 
   /**
    * The list of rules in the ruleset.