feat(api): update via SDK Studio (#670)

cloudflare · May 27, 2024 · 14f40c3 · 14f40c3
1 parent bcfa71f
commit 14f40c3
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 5 deletions.
diff --git a/src/resources/filters.ts b/src/resources/filters.ts
@@ -9,7 +9,7 @@ export class Filters extends APIResource {
   /**
    * Creates one or more filters.
    *
-   * @deprecated Filters are being deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
+   * @deprecated The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   create(
     zoneIdentifier: string,
@@ -26,7 +26,7 @@ export class Filters extends APIResource {
   /**
    * Updates an existing filter.
    *
-   * @deprecated Filters are being deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
+   * @deprecated The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   update(
     zoneIdentifier: string,
@@ -45,7 +45,7 @@ export class Filters extends APIResource {
    * Fetches filters in a zone. You can filter the results using several optional
    * parameters.
    *
-   * @deprecated Filters are being deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
+   * @deprecated The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   list(
     zoneIdentifier: string,
@@ -73,7 +73,7 @@ export class Filters extends APIResource {
   /**
    * Deletes an existing filter.
    *
-   * @deprecated Filters are being deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
+   * @deprecated The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   delete(zoneIdentifier: string, id: string, options?: Core.RequestOptions): Core.APIPromise<FirewallFilter> {
     return (
@@ -86,7 +86,7 @@ export class Filters extends APIResource {
   /**
    * Fetches the details of a filter.
    *
-   * @deprecated Filters are being deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
+   * @deprecated The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   get(zoneIdentifier: string, id: string, options?: Core.RequestOptions): Core.APIPromise<FirewallFilter> {
     return (

diff --git a/src/resources/firewall/rules.ts b/src/resources/firewall/rules.ts
@@ -11,6 +11,8 @@ import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../p
 export class Rules extends APIResource {
   /**
    * Create one or more firewall rules.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   create(
     zoneIdentifier: string,
@@ -26,6 +28,8 @@ export class Rules extends APIResource {
 
   /**
    * Updates an existing firewall rule.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   update(
     zoneIdentifier: string,
@@ -44,6 +48,8 @@ export class Rules extends APIResource {
   /**
    * Fetches firewall rules in a zone. You can filter the results using several
    * optional parameters.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   list(
     zoneIdentifier: string,
@@ -71,6 +77,8 @@ export class Rules extends APIResource {
 
   /**
    * Deletes an existing firewall rule.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   delete(zoneIdentifier: string, id: string, options?: Core.RequestOptions): Core.APIPromise<FirewallRule> {
     return (
@@ -82,6 +90,8 @@ export class Rules extends APIResource {
 
   /**
    * Updates the priority of an existing firewall rule.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   edit(
     zoneIdentifier: string,
@@ -99,6 +109,8 @@ export class Rules extends APIResource {
 
   /**
    * Fetches the details of a firewall rule.
+   *
+   * @deprecated The Firewall Rules API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.
    */
   get(
     zoneIdentifier: string,

diff --git a/src/resources/pagerules/pagerules.ts b/src/resources/pagerules/pagerules.ts
@@ -9,6 +9,8 @@ export class Pagerules extends APIResource {
 
   /**
    * Creates a new Page Rule.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   create(
     params: PageruleCreateParams,
@@ -25,6 +27,8 @@ export class Pagerules extends APIResource {
   /**
    * Replaces the configuration of an existing Page Rule. The configuration of the
    * updated Page Rule will exactly match the data passed in the API request.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   update(
     pageruleId: string,
@@ -41,6 +45,8 @@ export class Pagerules extends APIResource {
 
   /**
    * Fetches Page Rules in a zone.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   list(params: PageruleListParams, options?: Core.RequestOptions): Core.APIPromise<PageruleListResponse> {
     const { zone_id, ...query } = params;
@@ -53,6 +59,8 @@ export class Pagerules extends APIResource {
 
   /**
    * Deletes an existing Page Rule.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   delete(
     pageruleId: string,
@@ -69,6 +77,8 @@ export class Pagerules extends APIResource {
 
   /**
    * Updates one or more fields of an existing Page Rule.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   edit(
     pageruleId: string,
@@ -86,6 +96,8 @@ export class Pagerules extends APIResource {
 
   /**
    * Fetches the details of a Page Rule.
+   *
+   * @deprecated The Page Rules API is deprecated in favour of the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#page-rules for full details.
    */
   get(
     pageruleId: string,

diff --git a/src/resources/rate-limits.ts b/src/resources/rate-limits.ts
@@ -10,6 +10,8 @@ export class RateLimits extends APIResource {
   /**
    * Creates a new rate limit for a zone. Refer to the object definition for a list
    * of required attributes.
+   *
+   * @deprecated Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.
    */
   create(
     zoneIdentifier: string,
@@ -25,6 +27,8 @@ export class RateLimits extends APIResource {
 
   /**
    * Fetches the rate limits for a zone.
+   *
+   * @deprecated Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.
    */
   list(
     zoneIdentifier: string,
@@ -51,6 +55,8 @@ export class RateLimits extends APIResource {
 
   /**
    * Deletes an existing rate limit.
+   *
+   * @deprecated Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.
    */
   delete(
     zoneIdentifier: string,
@@ -66,6 +72,8 @@ export class RateLimits extends APIResource {
 
   /**
    * Updates an existing rate limit.
+   *
+   * @deprecated Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.
    */
   edit(
     zoneIdentifier: string,
@@ -83,6 +91,8 @@ export class RateLimits extends APIResource {
 
   /**
    * Fetches the details of a rate limit.
+   *
+   * @deprecated Rate limiting API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#rate-limiting-api-previous-version for full details.
    */
   get(
     zoneIdentifier: string,