cloudflare 3.0.0-beta.1 → 3.0.0-beta.3

package/src/resources/challenges/widgets.ts

@@ -1,5 +1,395 @@
 // File generated from our OpenAPI spec by Stainless.
 
+import * as Core from "../../core";
 import { APIResource } from "../../resource";
+import * as WidgetsAPI from "./widgets";
+import { V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../pagination";
 
-export class Widgets extends APIResource {}
+export class Widgets extends APIResource {
+  /**
+   * Lists challenge widgets.
+   */
+  create(
+    params: WidgetCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NcChallengesAdminWidgetDetail> {
+    const { account_id, direction, order, page, per_page, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/challenges/widgets`, {
+        query: { direction, order, page, per_page },
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Update the configuration of a widget.
+   */
+  update(
+    sitekey: string,
+    params: WidgetUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NcChallengesAdminWidgetDetail> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/challenges/widgets/${sitekey}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Lists all turnstile widgets of an account.
+   */
+  list(
+    params: WidgetListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<NcChallengesAdminWidgetListsV4PagePaginationArray, NcChallengesAdminWidgetList> {
+    const { account_id, ...query } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/challenges/widgets`,
+      NcChallengesAdminWidgetListsV4PagePaginationArray,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Destroy a Turnstile Widget.
+   */
+  delete(
+    sitekey: string,
+    params: WidgetDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NcChallengesAdminWidgetDetail> {
+    const { account_id } = params;
+    return (
+      this._client.delete(
+        `/accounts/${account_id}/challenges/widgets/${sitekey}`,
+        options,
+      ) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Show a single challenge widget configuration.
+   */
+  get(
+    sitekey: string,
+    params: WidgetGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NcChallengesAdminWidgetDetail> {
+    const { account_id } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/challenges/widgets/${sitekey}`, options) as Core.APIPromise<{
+        result: NcChallengesAdminWidgetDetail;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Generate a new secret key for this widget. If `invalidate_immediately` is set to
+   * `false`, the previous secret remains valid for 2 hours.
+   *
+   * Note that secrets cannot be rotated again during the grace period.
+   */
+  rotateSecret(
+    sitekey: string,
+    params: WidgetRotateSecretParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<NcChallengesAdminWidgetDetail> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/challenges/widgets/${sitekey}/rotate_secret`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: NcChallengesAdminWidgetDetail }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class NcChallengesAdminWidgetListsV4PagePaginationArray extends V4PagePaginationArray<NcChallengesAdminWidgetList> {}
+
+/**
+ * A Turnstile widget's detailed configuration
+ */
+export interface NcChallengesAdminWidgetDetail {
+  /**
+   * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
+   * challenges in response to malicious bots (ENT only).
+   */
+  bot_fight_mode: boolean;
+
+  /**
+   * If Turnstile is embedded on a Cloudflare site and the widget should grant
+   * challenge clearance, this setting can determine the clearance level to be set
+   */
+  clearance_level: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
+
+  /**
+   * When the widget was created.
+   */
+  created_on: string;
+
+  domains: Array<string>;
+
+  /**
+   * Widget Mode
+   */
+  mode: 'non-interactive' | 'invisible' | 'managed';
+
+  /**
+   * When the widget was modified.
+   */
+  modified_on: string;
+
+  /**
+   * Human readable widget name. Not unique. Cloudflare suggests that you set this to
+   * a meaningful string to make it easier to identify your widget, and where it is
+   * used.
+   */
+  name: string;
+
+  /**
+   * Do not show any Cloudflare branding on the widget (ENT only).
+   */
+  offlabel: boolean;
+
+  /**
+   * Region where this widget can be used.
+   */
+  region: 'world';
+
+  /**
+   * Secret key for this widget.
+   */
+  secret: string;
+
+  /**
+   * Widget item identifier tag.
+   */
+  sitekey: string;
+}
+
+/**
+ * A Turnstile Widgets configuration as it appears in listings
+ */
+export interface NcChallengesAdminWidgetList {
+  /**
+   * If bot_fight_mode is set to `true`, Cloudflare issues computationally expensive
+   * challenges in response to malicious bots (ENT only).
+   */
+  bot_fight_mode: boolean;
+
+  /**
+   * If Turnstile is embedded on a Cloudflare site and the widget should grant
+   * challenge clearance, this setting can determine the clearance level to be set
+   */
+  clearance_level: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
+
+  /**
+   * When the widget was created.
+   */
+  created_on: string;
+
+  domains: Array<string>;
+
+  /**
+   * Widget Mode
+   */
+  mode: 'non-interactive' | 'invisible' | 'managed';
+
+  /**
+   * When the widget was modified.
+   */
+  modified_on: string;
+
+  /**
+   * Human readable widget name. Not unique. Cloudflare suggests that you set this to
+   * a meaningful string to make it easier to identify your widget, and where it is
+   * used.
+   */
+  name: string;
+
+  /**
+   * Do not show any Cloudflare branding on the widget (ENT only).
+   */
+  offlabel: boolean;
+
+  /**
+   * Region where this widget can be used.
+   */
+  region: 'world';
+
+  /**
+   * Widget item identifier tag.
+   */
+  sitekey: string;
+}
+
+export interface WidgetCreateParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  domains: Array<string>;
+
+  /**
+   * Body param: Widget Mode
+   */
+  mode: 'non-interactive' | 'invisible' | 'managed';
+
+  /**
+   * Body param: Human readable widget name. Not unique. Cloudflare suggests that you
+   * set this to a meaningful string to make it easier to identify your widget, and
+   * where it is used.
+   */
+  name: string;
+
+  /**
+   * Query param: Direction to order widgets.
+   */
+  direction?: 'asc' | 'desc';
+
+  /**
+   * Query param: Field to order widgets by.
+   */
+  order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
+
+  /**
+   * Query param: Page number of paginated results.
+   */
+  page?: number;
+
+  /**
+   * Query param: Number of items per page.
+   */
+  per_page?: number;
+
+  /**
+   * Body param: If bot_fight_mode is set to `true`, Cloudflare issues
+   * computationally expensive challenges in response to malicious bots (ENT only).
+   */
+  bot_fight_mode?: boolean;
+
+  /**
+   * Body param: If Turnstile is embedded on a Cloudflare site and the widget should
+   * grant challenge clearance, this setting can determine the clearance level to be
+   * set
+   */
+  clearance_level?: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
+
+  /**
+   * Body param: Do not show any Cloudflare branding on the widget (ENT only).
+   */
+  offlabel?: boolean;
+
+  /**
+   * Body param: Region where this widget can be used.
+   */
+  region?: 'world';
+}
+
+export interface WidgetUpdateParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  domains: Array<string>;
+
+  /**
+   * Body param: Widget Mode
+   */
+  mode: 'non-interactive' | 'invisible' | 'managed';
+
+  /**
+   * Body param: Human readable widget name. Not unique. Cloudflare suggests that you
+   * set this to a meaningful string to make it easier to identify your widget, and
+   * where it is used.
+   */
+  name: string;
+
+  /**
+   * Body param: If bot_fight_mode is set to `true`, Cloudflare issues
+   * computationally expensive challenges in response to malicious bots (ENT only).
+   */
+  bot_fight_mode?: boolean;
+
+  /**
+   * Body param: If Turnstile is embedded on a Cloudflare site and the widget should
+   * grant challenge clearance, this setting can determine the clearance level to be
+   * set
+   */
+  clearance_level?: 'no_clearance' | 'jschallenge' | 'managed' | 'interactive';
+
+  /**
+   * Body param: Do not show any Cloudflare branding on the widget (ENT only).
+   */
+  offlabel?: boolean;
+}
+
+export interface WidgetListParams extends V4PagePaginationArrayParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Query param: Direction to order widgets.
+   */
+  direction?: 'asc' | 'desc';
+
+  /**
+   * Query param: Field to order widgets by.
+   */
+  order?: 'id' | 'sitekey' | 'name' | 'created_on' | 'modified_on';
+}
+
+export interface WidgetDeleteParams {
+  /**
+   * Identifier
+   */
+  account_id: string;
+}
+
+export interface WidgetGetParams {
+  /**
+   * Identifier
+   */
+  account_id: string;
+}
+
+export interface WidgetRotateSecretParams {
+  /**
+   * Path param: Identifier
+   */
+  account_id: string;
+
+  /**
+   * Body param: If `invalidate_immediately` is set to `false`, the previous secret
+   * will remain valid for two hours. Otherwise, the secret is immediately
+   * invalidated, and requests using it will be rejected.
+   */
+  invalidate_immediately?: boolean;
+}
+
+export namespace Widgets {
+  export import NcChallengesAdminWidgetDetail = WidgetsAPI.NcChallengesAdminWidgetDetail;
+  export import NcChallengesAdminWidgetList = WidgetsAPI.NcChallengesAdminWidgetList;
+  export import NcChallengesAdminWidgetListsV4PagePaginationArray = WidgetsAPI.NcChallengesAdminWidgetListsV4PagePaginationArray;
+  export import WidgetCreateParams = WidgetsAPI.WidgetCreateParams;
+  export import WidgetUpdateParams = WidgetsAPI.WidgetUpdateParams;
+  export import WidgetListParams = WidgetsAPI.WidgetListParams;
+  export import WidgetDeleteParams = WidgetsAPI.WidgetDeleteParams;
+  export import WidgetGetParams = WidgetsAPI.WidgetGetParams;
+  export import WidgetRotateSecretParams = WidgetsAPI.WidgetRotateSecretParams;
+}

package/src/resources/index.ts

@@ -85,7 +85,7 @@ export {
 } from './healthchecks/healthchecks';
 export { Hostnames } from './hostnames/hostnames';
 export { Hyperdrive } from './hyperdrive/hyperdrive';
-export { IPs, JdcloudIPs, IPListResponse, IPListParams } from './ips';
+export { IPs, JDCloudIPs, IPListResponse, IPListParams } from './ips';
 export { Images } from './images/images';
 export { Intel } from './intel/intel';
 export {

package/src/resources/ips.ts

@@ -44,7 +44,7 @@ export interface IPs {
   ipv6_cidrs?: Array<string>;
 }
 
-export interface JdcloudIPs {
+export interface JDCloudIPs {
   /**
    * A digest of the IP data. Useful for determining if the data has changed.
    */
@@ -66,7 +66,7 @@ export interface JdcloudIPs {
   jdcloud_cidrs?: Array<string>;
 }
 
-export type IPListResponse = IPs | JdcloudIPs;
+export type IPListResponse = IPs | JDCloudIPs;
 
 export interface IPListParams {
   /**
@@ -77,7 +77,7 @@ export interface IPListParams {
 
 export namespace IPs {
   export import IPs = IPsAPI.IPs;
-  export import JdcloudIPs = IPsAPI.JdcloudIPs;
+  export import JDCloudIPs = IPsAPI.JDCloudIPs;
   export import IPListResponse = IPsAPI.IPListResponse;
   export import IPListParams = IPsAPI.IPListParams;
 }

package/src/resources/page-shield/scripts.ts

@@ -35,6 +35,8 @@ export interface PageShieldScript {
 
   added_at?: unknown;
 
+  dataflow_score?: unknown;
+
   domain_reported_malicious?: unknown;
 
   fetched_at?: unknown;
@@ -51,6 +53,8 @@ export interface PageShieldScript {
 
   last_seen_at?: unknown;
 
+  obfuscation_score?: unknown;
+
   page_urls?: unknown;
 
   url?: unknown;
@@ -65,6 +69,8 @@ export interface ScriptGetResponse {
 
   added_at?: unknown;
 
+  dataflow_score?: unknown;
+
   domain_reported_malicious?: unknown;
 
   fetched_at?: unknown;
@@ -81,6 +87,8 @@ export interface ScriptGetResponse {
 
   last_seen_at?: unknown;
 
+  obfuscation_score?: unknown;
+
   page_urls?: unknown;
 
   url?: unknown;
@@ -95,6 +103,11 @@ export namespace ScriptGetResponse {
    * The version of the analyzed script.
    */
   export interface Version {
+    /**
+     * The dataflow score of the JavaScript content.
+     */
+    dataflow_score?: number | null;
+
     /**
      * The timestamp of when the script was last fetched.
      */
@@ -109,6 +122,11 @@ export namespace ScriptGetResponse {
      * The integrity score of the JavaScript content.
      */
     js_integrity_score?: number | null;
+
+    /**
+     * The obfuscation score of the JavaScript content.
+     */
+    obfuscation_score?: number | null;
   }
 }
 

package/src/resources/zero-trust/access/access.ts

@@ -70,7 +70,7 @@ export namespace Access {
   export import BookmarkDeleteResponse = BookmarksAPI.BookmarkDeleteResponse;
   export import Keys = KeysAPI.Keys;
   export import KeyUpdateResponse = KeysAPI.KeyUpdateResponse;
-  export import KeyListResponse = KeysAPI.KeyListResponse;
+  export import KeyGetResponse = KeysAPI.KeyGetResponse;
   export import KeyRotateResponse = KeysAPI.KeyRotateResponse;
   export import KeyUpdateParams = KeysAPI.KeyUpdateParams;
   export import Logs = LogsAPI.Logs;

package/src/resources/zero-trust/access/certificates/certificates.ts

@@ -338,7 +338,7 @@ export namespace Certificates {
   export import Settings = SettingsAPI.Settings;
   export import AccessSettings = SettingsAPI.AccessSettings;
   export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
-  export import SettingListResponse = SettingsAPI.SettingListResponse;
+  export import SettingGetResponse = SettingsAPI.SettingGetResponse;
   export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
-  export import SettingListParams = SettingsAPI.SettingListParams;
+  export import SettingGetParams = SettingsAPI.SettingGetParams;
 }

package/src/resources/zero-trust/access/certificates/index.ts

@@ -14,8 +14,8 @@ export {
 export {
   AccessSettings,
   SettingUpdateResponse,
-  SettingListResponse,
+  SettingGetResponse,
   SettingUpdateParams,
-  SettingListParams,
+  SettingGetParams,
   Settings,
 } from './settings';

package/src/resources/zero-trust/access/certificates/settings.ts

@@ -42,17 +42,14 @@ export class Settings extends APIResource {
   /**
    * List all mTLS hostname settings for this account or zone.
    */
-  list(
-    params?: SettingListParams,
+  get(params?: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse | null>;
+  get(options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse | null>;
+  get(
+    params: SettingGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<SettingListResponse | null>;
-  list(options?: Core.RequestOptions): Core.APIPromise<SettingListResponse | null>;
-  list(
-    params: SettingListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<SettingListResponse | null> {
+  ): Core.APIPromise<SettingGetResponse | null> {
     if (isRequestOptions(params)) {
-      return this.list({}, params);
+      return this.get({}, params);
     }
     const { account_id, zone_id } = params;
     if (!account_id && !zone_id) {
@@ -75,7 +72,7 @@ export class Settings extends APIResource {
       this._client.get(
         `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
         options,
-      ) as Core.APIPromise<{ result: SettingListResponse | null }>
+      ) as Core.APIPromise<{ result: SettingGetResponse | null }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
@@ -102,7 +99,7 @@ export interface AccessSettings {
 
 export type SettingUpdateResponse = Array<AccessSettings>;
 
-export type SettingListResponse = Array<AccessSettings>;
+export type SettingGetResponse = Array<AccessSettings>;
 
 export interface SettingUpdateParams {
   /**
@@ -123,7 +120,7 @@ export interface SettingUpdateParams {
   zone_id?: string;
 }
 
-export interface SettingListParams {
+export interface SettingGetParams {
   /**
    * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
    */
@@ -138,7 +135,7 @@ export interface SettingListParams {
 export namespace Settings {
   export import AccessSettings = SettingsAPI.AccessSettings;
   export import SettingUpdateResponse = SettingsAPI.SettingUpdateResponse;
-  export import SettingListResponse = SettingsAPI.SettingListResponse;
+  export import SettingGetResponse = SettingsAPI.SettingGetResponse;
   export import SettingUpdateParams = SettingsAPI.SettingUpdateParams;
-  export import SettingListParams = SettingsAPI.SettingListParams;
+  export import SettingGetParams = SettingsAPI.SettingGetParams;
 }

package/src/resources/zero-trust/access/index.ts

@@ -66,5 +66,5 @@ export {
   Tags,
 } from './tags';
 export { AccessUsers, UserListResponse, Users } from './users/index';
-export { KeyUpdateResponse, KeyListResponse, KeyRotateResponse, KeyUpdateParams, Keys } from './keys';
+export { KeyUpdateResponse, KeyGetResponse, KeyRotateResponse, KeyUpdateParams, Keys } from './keys';
 export { Logs } from './logs/index';

package/src/resources/zero-trust/access/keys.ts

@@ -23,10 +23,10 @@ export class Keys extends APIResource {
   /**
    * Gets the Access key rotation settings for an account.
    */
-  list(identifier: string, options?: Core.RequestOptions): Core.APIPromise<KeyListResponse> {
+  get(identifier: string, options?: Core.RequestOptions): Core.APIPromise<KeyGetResponse> {
     return (
       this._client.get(`/accounts/${identifier}/access/keys`, options) as Core.APIPromise<{
-        result: KeyListResponse;
+        result: KeyGetResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -45,7 +45,7 @@ export class Keys extends APIResource {
 
 export type KeyUpdateResponse = unknown | string;
 
-export type KeyListResponse = unknown | string;
+export type KeyGetResponse = unknown | string;
 
 export type KeyRotateResponse = unknown | string;
 
@@ -58,7 +58,7 @@ export interface KeyUpdateParams {
 
 export namespace Keys {
   export import KeyUpdateResponse = KeysAPI.KeyUpdateResponse;
-  export import KeyListResponse = KeysAPI.KeyListResponse;
+  export import KeyGetResponse = KeysAPI.KeyGetResponse;
   export import KeyRotateResponse = KeysAPI.KeyRotateResponse;
   export import KeyUpdateParams = KeysAPI.KeyUpdateParams;
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.0.0-beta.1'; // x-release-please-version
+export const VERSION = '3.0.0-beta.3'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.0.0-beta.1";
+export declare const VERSION = "3.0.0-beta.3";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '3.0.0-beta.1'; // x-release-please-version
+exports.VERSION = '3.0.0-beta.3'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '3.0.0-beta.1'; // x-release-please-version
+export const VERSION = '3.0.0-beta.3'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map