cloudflare 7.0.0 → 7.1.0

package/src/resources/abuse-reports/abuse-reports.ts

@@ -21,7 +21,37 @@ export class BaseAbuseReports extends APIResource {
   static override readonly _key: readonly ['abuseReports'] = Object.freeze(['abuseReports'] as const);
 
   /**
-   * Submit the Abuse Report of a particular type
+   * Submit an abuse report of a particular type.
+   *
+   * Requires the abuse-reports entitlement on the account (Enterprise accounts have
+   * it by default; other accounts must request access) and an API token with the
+   * `Account > Abuse Reports > Edit` permission. If the account is not entitled, the
+   * request is rejected with an HTTP `401` response (see below).
+   *
+   * @example
+   * ```ts
+   * const abuseReport = await client.abuseReports.create(
+   *   'report_param',
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     act: 'abuse_dmca',
+   *     address1: 'x',
+   *     agent_name: 'x',
+   *     agree: 1,
+   *     city: 'x',
+   *     country: 'x',
+   *     email: 'email',
+   *     email2: 'email2',
+   *     host_notification: 'send',
+   *     name: 'x',
+   *     original_work: 'x',
+   *     owner_notification: 'send',
+   *     signature: 'signature',
+   *     state: 'x',
+   *     urls: 'urls',
+   *   },
+   * );
+   * ```
    */
   create(
     reportParam: string,
@@ -39,6 +69,16 @@ export class BaseAbuseReports extends APIResource {
 
   /**
    * List the abuse reports for a given account
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const abuseReportListResponse of client.abuseReports.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     params: AbuseReportListParams,
@@ -54,6 +94,14 @@ export class BaseAbuseReports extends APIResource {
 
   /**
    * Retrieve the details of an abuse report.
+   *
+   * @example
+   * ```ts
+   * const abuseReport = await client.abuseReports.get(
+   *   'report_param',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
    */
   get(
     reportParam: string,

package/src/resources/abuse-reports/mitigations.ts

@@ -18,6 +18,17 @@ export class BaseMitigations extends APIResource {
 
   /**
    * List mitigations done to remediate the abuse report.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const mitigationListResponse of client.abuseReports.mitigations.list(
+   *   'report_id',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     reportID: string,
@@ -34,6 +45,17 @@ export class BaseMitigations extends APIResource {
 
   /**
    * Request a review for mitigations on an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const mitigationReviewResponse of client.abuseReports.mitigations.review(
+   *   'report_id',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   review(
     reportID: string,
@@ -101,6 +123,7 @@ export namespace MitigationListResponse {
       | 'r2_takedown_object'
       | 'rate_limit_cache'
       | 'redirect_video_stream'
+      | 'zone_fint'
       | 'registrar_freeze'
       | 'registrar_parking'
       | 'stream_block_account'
@@ -151,6 +174,7 @@ export interface MitigationReviewResponse {
     | 'r2_takedown_object'
     | 'rate_limit_cache'
     | 'redirect_video_stream'
+    | 'zone_fint'
     | 'registrar_freeze'
     | 'registrar_parking'
     | 'stream_block_account'
@@ -217,6 +241,7 @@ export interface MitigationListParams extends V4PagePaginationParams {
     | 'r2_takedown_object'
     | 'rate_limit_cache'
     | 'redirect_video_stream'
+    | 'zone_fint'
     | 'registrar_freeze'
     | 'registrar_parking'
     | 'stream_block_account'
@@ -233,7 +258,17 @@ export interface MitigationReviewParams {
   /**
    * Body param: List of mitigations to appeal.
    */
-  appeals: Array<MitigationReviewParams.Appeal>;
+  appeals?: Array<MitigationReviewParams.Appeal>;
+
+  /**
+   * Body param: Counter-notice details supporting an appeal.
+   */
+  data?: MitigationReviewParams.Data;
+
+  /**
+   * Body param: The type of appeal being submitted.
+   */
+  type?: 'counter_notice' | 'content_removed';
 }
 
 export namespace MitigationReviewParams {
@@ -248,6 +283,39 @@ export namespace MitigationReviewParams {
      */
     reason: 'removed' | 'misclassified';
   }
+
+  /**
+   * Counter-notice details supporting an appeal.
+   */
+  export interface Data {
+    city: string;
+
+    country: string;
+
+    email: string;
+
+    full_name: string;
+
+    jurisdiction_consent: boolean;
+
+    perjury_attestation: boolean;
+
+    phone_number: string;
+
+    signature: string;
+
+    state: string;
+
+    street_address: string;
+
+    urls: Array<string>;
+
+    zip_code: string;
+
+    company?: string;
+
+    counter_notice_response?: string;
+  }
 }
 
 export declare namespace Mitigations {

package/src/resources/accounts/accounts.ts

@@ -27,6 +27,8 @@ import {
 } from './subscriptions';
 import * as LogsAPI from './logs/logs';
 import { BaseLogs, Logs } from './logs/logs';
+import * as SpeedSettingsAPI from './speed-settings/speed-settings';
+import { BaseSpeedSettings, SpeedSettings } from './speed-settings/speed-settings';
 import * as TokensAPI from './tokens/tokens';
 import {
   BaseTokens,
@@ -147,6 +149,7 @@ export class Accounts extends BaseAccounts {
   subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
   tokens: TokensAPI.Tokens = new TokensAPI.Tokens(this._client);
   logs: LogsAPI.Logs = new LogsAPI.Logs(this._client);
+  speedSettings: SpeedSettingsAPI.SpeedSettings = new SpeedSettingsAPI.SpeedSettings(this._client);
 }
 
 export type AccountsV4PagePaginationArray = V4PagePaginationArray<Account>;
@@ -341,6 +344,8 @@ Accounts.Tokens = Tokens;
 Accounts.BaseTokens = BaseTokens;
 Accounts.Logs = Logs;
 Accounts.BaseLogs = BaseLogs;
+Accounts.SpeedSettings = SpeedSettings;
+Accounts.BaseSpeedSettings = BaseSpeedSettings;
 
 export declare namespace Accounts {
   export {
@@ -398,4 +403,6 @@ export declare namespace Accounts {
   };
 
   export { Logs as Logs, BaseLogs as BaseLogs };
+
+  export { SpeedSettings as SpeedSettings, BaseSpeedSettings as BaseSpeedSettings };
 }

package/src/resources/accounts/api.md

@@ -43,10 +43,10 @@ Types:
 
 Methods:
 
-- <code title="post /accounts/{account_id}/subscriptions">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">create</a>({ ...params }) -> Subscription</code>
+- <code title="post /{accounts_or_zones}/{account_or_zone_id}/subscriptions">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">create</a>({ ...params }) -> Subscription</code>
 - <code title="put /accounts/{account_id}/subscriptions/{subscription_identifier}">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">update</a>(subscriptionIdentifier, { ...params }) -> Subscription</code>
 - <code title="delete /accounts/{account_id}/subscriptions/{subscription_identifier}">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">delete</a>(subscriptionIdentifier, { ...params }) -> SubscriptionDeleteResponse</code>
-- <code title="get /accounts/{account_id}/subscriptions">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">get</a>({ ...params }) -> SubscriptionsSinglePage</code>
+- <code title="get /{accounts_or_zones}/{account_or_zone_id}/subscriptions">client.accounts.subscriptions.<a href="./src/resources/accounts/subscriptions.ts">get</a>({ ...params }) -> SubscriptionsSinglePage</code>
 
 ## Tokens
 
@@ -98,3 +98,15 @@ Methods:
 - <code title="get /accounts/{account_id}/logs/audit">client.accounts.logs.audit.<a href="./src/resources/accounts/logs/audit.ts">list</a>({ ...params }) -> AuditListResponsesCursorPaginationAfter</code>
 - <code title="get /accounts/{account_id}/logs/audit/{id}/history">client.accounts.logs.audit.<a href="./src/resources/accounts/logs/audit.ts">history</a>(id, { ...params }) -> AuditHistoryResponse</code>
 - <code title="get /accounts/{account_id}/logs/audit/product_categories">client.accounts.logs.audit.<a href="./src/resources/accounts/logs/audit.ts">productCategories</a>({ ...params }) -> AuditProductCategoriesResponsesSinglePage</code>
+
+## SpeedSettings
+
+### Transformations
+
+Types:
+
+- <code><a href="./src/resources/accounts/speed-settings/transformations.ts">TransformationsConfig</a></code>
+
+Methods:
+
+- <code title="get /accounts/{account_id}/settings/transformations">client.accounts.speedSettings.transformations.<a href="./src/resources/accounts/speed-settings/transformations.ts">get</a>({ ...params }) -> TransformationsConfigsSinglePage</code>

package/src/resources/accounts/index.ts

@@ -14,6 +14,7 @@ export {
   type MemberGetParams,
 } from './members';
 export { Roles, BaseRoles, type RoleListParams, type RoleGetParams } from './roles';
+export { SpeedSettings, BaseSpeedSettings } from './speed-settings/index';
 export {
   Subscriptions,
   BaseSubscriptions,

package/src/resources/accounts/roles.ts

@@ -8,6 +8,9 @@ import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams }
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * @deprecated Please use the [Account Permission Groups](https://developers.cloudflare.com/api/resources/iam/subresources/permission_groups/) API instead
+ */
 export class BaseRoles extends APIResource {
   static override readonly _key: readonly ['accounts', 'roles'] = Object.freeze([
     'accounts',
@@ -17,15 +20,7 @@ export class BaseRoles extends APIResource {
   /**
    * Get all available roles for an account.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const role of client.accounts.roles.list({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * })) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated Use /accounts/{account_id}/iam/permission_groups instead.
    */
   list(
     params: RoleListParams,
@@ -41,13 +36,7 @@ export class BaseRoles extends APIResource {
   /**
    * Get information about a specific role for an account.
    *
-   * @example
-   * ```ts
-   * const role = await client.accounts.roles.get(
-   *   '3536bcfad5faccb999b47003c79917fb',
-   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated Use /accounts/{account_id}/iam/permission_groups/{permission_group_id} instead.
    */
   get(roleID: string, params: RoleGetParams, options?: RequestOptions): APIPromise<Shared.Role> {
     const { account_id } = params;
@@ -58,6 +47,9 @@ export class BaseRoles extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 }
+/**
+ * @deprecated Please use the [Account Permission Groups](https://developers.cloudflare.com/api/resources/iam/subresources/permission_groups/) API instead
+ */
 export class Roles extends BaseRoles {}
 
 export interface RoleListParams extends V4PagePaginationArrayParams {

package/src/resources/accounts/speed-settings/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { SpeedSettings, BaseSpeedSettings } from './speed-settings';
+export {
+  Transformations,
+  BaseTransformations,
+  type TransformationsConfig,
+  type TransformationGetParams,
+  type TransformationsConfigsSinglePage,
+} from './transformations';

package/src/resources/accounts/speed-settings/speed-settings.ts

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as TransformationsAPI from './transformations';
+import {
+  BaseTransformations,
+  TransformationGetParams,
+  Transformations,
+  TransformationsConfig,
+  TransformationsConfigsSinglePage,
+} from './transformations';
+
+export class BaseSpeedSettings extends APIResource {
+  static override readonly _key: readonly ['accounts', 'speedSettings'] = Object.freeze([
+    'accounts',
+    'speedSettings',
+  ] as const);
+}
+export class SpeedSettings extends BaseSpeedSettings {
+  transformations: TransformationsAPI.Transformations = new TransformationsAPI.Transformations(this._client);
+}
+
+SpeedSettings.Transformations = Transformations;
+SpeedSettings.BaseTransformations = BaseTransformations;
+
+export declare namespace SpeedSettings {
+  export {
+    Transformations as Transformations,
+    BaseTransformations as BaseTransformations,
+    type TransformationsConfig as TransformationsConfig,
+    type TransformationsConfigsSinglePage as TransformationsConfigsSinglePage,
+    type TransformationGetParams as TransformationGetParams,
+  };
+}

package/src/resources/accounts/speed-settings/transformations.ts

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { PagePromise, SinglePage } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class BaseTransformations extends APIResource {
+  static override readonly _key: readonly ['accounts', 'speedSettings', 'transformations'] = Object.freeze([
+    'accounts',
+    'speedSettings',
+    'transformations',
+  ] as const);
+
+  /**
+   * Returns a list of Image Resizing configurations across all zones for the
+   * account. This endpoint is useful for retrieving the transformations
+   * (image_resizing) state for all zones belonging to an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const transformationsConfig of client.accounts.speedSettings.transformations.get(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  get(
+    params: TransformationGetParams,
+    options?: RequestOptions,
+  ): PagePromise<TransformationsConfigsSinglePage, TransformationsConfig> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      path`/accounts/${account_id}/settings/transformations`,
+      SinglePage<TransformationsConfig>,
+      options,
+    );
+  }
+}
+export class Transformations extends BaseTransformations {}
+
+export type TransformationsConfigsSinglePage = SinglePage<TransformationsConfig>;
+
+/**
+ * A configuration item for a specific zone and feature.
+ */
+export interface TransformationsConfig {
+  /**
+   * Feature identifier.
+   */
+  id?: string;
+
+  /**
+   * Zone tag identifier.
+   */
+  cf_zone_tag?: string;
+
+  /**
+   * Whether this setting can be modified.
+   */
+  editable?: boolean;
+
+  /**
+   * When this setting was last modified.
+   */
+  modified_on?: string | null;
+
+  /**
+   * Current value of the feature setting.
+   */
+  value?: string;
+}
+
+export interface TransformationGetParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export declare namespace Transformations {
+  export {
+    type TransformationsConfig as TransformationsConfig,
+    type TransformationsConfigsSinglePage as TransformationsConfigsSinglePage,
+    type TransformationGetParams as TransformationGetParams,
+  };
+}

package/src/resources/accounts/speed-settings.ts

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

package/src/resources/accounts/subscriptions.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import { SubscriptionsSinglePage } from '../shared';
 import { APIPromise } from '../../core/api-promise';
+import { CloudflareError } from '../../core/error';
 import { PagePromise, SinglePage } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -15,22 +16,39 @@ export class BaseSubscriptions extends APIResource {
   ] as const);
 
   /**
-   * Creates an account subscription.
+   * Creates an account or zone subscription.
    *
    * @example
    * ```ts
    * const subscription =
    *   await client.accounts.subscriptions.create({
-   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     account_id: 'account_id',
    *   });
    * ```
    */
   create(params: SubscriptionCreateParams, options?: RequestOptions): APIPromise<Shared.Subscription> {
-    const { account_id, ...body } = params;
+    const { account_id, zone_id, ...body } = params;
+    if (!account_id && !zone_id) {
+      throw new CloudflareError('You must provide either account_id or zone_id.');
+    }
+    if (account_id && zone_id) {
+      throw new CloudflareError('You cannot provide both account_id and zone_id.');
+    }
+    const { accountOrZone, accountOrZoneId } =
+      account_id ?
+        {
+          accountOrZone: 'accounts',
+          accountOrZoneId: account_id,
+        }
+      : {
+          accountOrZone: 'zones',
+          accountOrZoneId: zone_id,
+        };
     return (
-      this._client.post(path`/accounts/${account_id}/subscriptions`, { body, ...options }) as APIPromise<{
-        result: Shared.Subscription;
-      }>
+      this._client.post(path`/${accountOrZone}/${accountOrZoneId}/subscriptions`, {
+        body,
+        ...options,
+      }) as APIPromise<{ result: Shared.Subscription }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -87,25 +105,41 @@ export class BaseSubscriptions extends APIResource {
   }
 
   /**
-   * Lists all of an account's subscriptions.
+   * Lists all of an account or zone's subscriptions.
    *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
    * for await (const subscription of client.accounts.subscriptions.get(
-   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   { account_id: 'account_id' },
    * )) {
    *   // ...
    * }
    * ```
    */
   get(
-    params: SubscriptionGetParams,
+    params: SubscriptionGetParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SubscriptionsSinglePage, Shared.Subscription> {
-    const { account_id } = params;
+    const { account_id, zone_id } = params ?? {};
+    if (!account_id && !zone_id) {
+      throw new CloudflareError('You must provide either account_id or zone_id.');
+    }
+    if (account_id && zone_id) {
+      throw new CloudflareError('You cannot provide both account_id and zone_id.');
+    }
+    const { accountOrZone, accountOrZoneId } =
+      account_id ?
+        {
+          accountOrZone: 'accounts',
+          accountOrZoneId: account_id,
+        }
+      : {
+          accountOrZone: 'zones',
+          accountOrZoneId: zone_id,
+        };
     return this._client.getAPIList(
-      path`/accounts/${account_id}/subscriptions`,
+      path`/${accountOrZone}/${accountOrZoneId}/subscriptions`,
       SinglePage<Shared.Subscription>,
       options,
     );
@@ -122,9 +156,16 @@ export interface SubscriptionDeleteResponse {
 
 export interface SubscriptionCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+   * Zone ID.
    */
-  account_id: string;
+  account_id?: string;
+
+  /**
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
+   */
+  zone_id?: string;
 
   /**
    * Body param: How often the subscription is renewed automatically.
@@ -163,9 +204,14 @@ export interface SubscriptionDeleteParams {
 
 export interface SubscriptionGetParams {
   /**
-   * Identifier
+   * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
    */
-  account_id: string;
+  account_id?: string;
+
+  /**
+   * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
+   */
+  zone_id?: string;
 }
 
 export declare namespace Subscriptions {

package/src/resources/accounts/tokens/tokens.ts

@@ -94,7 +94,9 @@ export class BaseTokens extends APIResource {
   }
 
   /**
-   * List all Account Owned API tokens created for this account.
+   * List all Account Owned API tokens created for this account. Results include
+   * active, disabled, and recently-expired tokens when include_expired is set to
+   * true.
    *
    * @example
    * ```ts
@@ -432,6 +434,11 @@ export interface TokenListParams extends V4PagePaginationArrayParams {
    * Query param: Direction to order results.
    */
   direction?: 'asc' | 'desc';
+
+  /**
+   * Query param: When true, includes recently-expired tokens in the response.
+   */
+  include_expired?: boolean;
 }
 
 export interface TokenDeleteParams {

package/src/resources/acm/acm.ts

@@ -15,7 +15,6 @@ import {
 import * as TotalTLSAPI from './total-tls';
 import {
   BaseTotalTLS,
-  CertificateAuthority,
   TotalTLS,
   TotalTLSEditParams,
   TotalTLSEditResponse,
@@ -43,7 +42,6 @@ export declare namespace ACM {
   export {
     TotalTLS as TotalTLS,
     BaseTotalTLS as BaseTotalTLS,
-    type CertificateAuthority as CertificateAuthority,
     type TotalTLSUpdateResponse as TotalTLSUpdateResponse,
     type TotalTLSEditResponse as TotalTLSEditResponse,
     type TotalTLSGetResponse as TotalTLSGetResponse,

package/src/resources/acm/api.md

@@ -4,7 +4,6 @@
 
 Types:
 
-- <code><a href="./src/resources/acm/total-tls.ts">CertificateAuthority</a></code>
 - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSUpdateResponse</a></code>
 - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSEditResponse</a></code>
 - <code><a href="./src/resources/acm/total-tls.ts">TotalTLSGetResponse</a></code>

package/src/resources/acm/index.ts

@@ -14,7 +14,6 @@ export {
 export {
   TotalTLS,
   BaseTotalTLS,
-  type CertificateAuthority,
   type TotalTLSUpdateResponse,
   type TotalTLSEditResponse,
   type TotalTLSGetResponse,