cloudflare 4.3.0 → 4.4.1

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

@@ -1,6 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { DEXTests, type SchemaData, type SchemaHTTP } from './dex-tests';
+export {
+  DEXTestListResponsesSinglePage,
+  DEXTests,
+  type SchemaData,
+  type SchemaHTTP,
+  type DEXTestCreateResponse,
+  type DEXTestUpdateResponse,
+  type DEXTestListResponse,
+  type DEXTestDeleteResponse,
+  type DEXTestGetResponse,
+  type DEXTestCreateParams,
+  type DEXTestUpdateParams,
+  type DEXTestListParams,
+  type DEXTestDeleteParams,
+  type DEXTestGetParams,
+} from './dex-tests';
 export {
   DeviceListResponsesCursorPagination,
   type DeviceListResponse,
@@ -86,6 +101,7 @@ export {
   Settings,
   type DeviceSettings,
   type SettingUpdateParams,
+  type SettingDeleteParams,
   type SettingEditParams,
   type SettingGetParams,
 } from './settings';

package/src/resources/zero-trust/devices/override-codes.ts

@@ -6,23 +6,15 @@ import { SinglePage } from '../../../pagination';
 
 export class OverrideCodes extends APIResource {
   /**
-   * Fetches a one-time use admin override code for a registration. This relies on
-   * the **Admin Override** setting being enabled in your device configuration.
-   *
-   * **Deprecated:** please use GET
+   * Fetches a one-time use admin override code for a device. This relies on the
+   * **Admin Override** setting being enabled in your device configuration. Not
+   * supported when
+   * [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/)
+   * is enabled for the account. **Deprecated:** please use GET
    * /accounts/{account_id}/devices/registrations/{registration_id}/override_codes
    * instead.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const overrideCodeListResponse of client.zeroTrust.devices.overrideCodes.list(
-   *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
-   *   { account_id: '699d98642c564d2e855e9661899b7252' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     deviceId: string,

package/src/resources/zero-trust/devices/posture/posture.ts

@@ -368,9 +368,8 @@ export namespace DeviceInput {
     operating_system: 'windows' | 'linux' | 'mac';
 
     /**
-     * Common Name that is protected by the client certificate. This may include one or
-     * more variables in the ${ } notation. Only ${serial_number} and ${hostname} are
-     * valid variables.
+     * Certificate Common Name. This may include one or more variables in the ${ }
+     * notation. Only ${serial_number} and ${hostname} are valid variables.
      */
     cn?: string;
 
@@ -381,6 +380,11 @@ export namespace DeviceInput {
     extended_key_usage?: Array<'clientAuth' | 'emailProtection'>;
 
     locations?: TeamsDevicesClientCertificateV2InputRequest.Locations;
+
+    /**
+     * List of certificate Subject Alternative Names.
+     */
+    subject_alternative_names?: Array<string>;
   }
 
   export namespace TeamsDevicesClientCertificateV2InputRequest {
@@ -509,9 +513,8 @@ export namespace DeviceInputParam {
     operating_system: 'windows' | 'linux' | 'mac';
 
     /**
-     * Common Name that is protected by the client certificate. This may include one or
-     * more variables in the ${ } notation. Only ${serial_number} and ${hostname} are
-     * valid variables.
+     * Certificate Common Name. This may include one or more variables in the ${ }
+     * notation. Only ${serial_number} and ${hostname} are valid variables.
      */
     cn?: string;
 
@@ -522,6 +525,11 @@ export namespace DeviceInputParam {
     extended_key_usage?: Array<'clientAuth' | 'emailProtection'>;
 
     locations?: TeamsDevicesClientCertificateV2InputRequest.Locations;
+
+    /**
+     * List of certificate Subject Alternative Names.
+     */
+    subject_alternative_names?: Array<string>;
   }
 
   export namespace TeamsDevicesClientCertificateV2InputRequest {

package/src/resources/zero-trust/devices/registrations.ts

@@ -6,7 +6,7 @@ import { CursorPagination, type CursorPaginationParams } from '../../../paginati
 
 export class Registrations extends APIResource {
   /**
-   * List WARP registrations.
+   * Lists WARP registrations.
    *
    * @example
    * ```ts
@@ -433,7 +433,7 @@ export namespace RegistrationListParams {
 
   export interface User {
     /**
-     * Filter by Access user ID.
+     * Filter by user ID.
      */
     id?: Array<string>;
   }

package/src/resources/zero-trust/devices/revoke.ts

@@ -5,20 +5,14 @@ import * as Core from '../../../core';
 
 export class Revoke extends APIResource {
   /**
-   * Revokes a list of registrations.
+   * Revokes a list of devices. Not supported when
+   * [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/)
+   * is enabled.
    *
    * **Deprecated**: please use POST
    * /accounts/{account_id}/devices/registrations/revoke instead.
    *
-   * @example
-   * ```ts
-   * const revoke = await client.zeroTrust.devices.revoke.create(
-   *   {
-   *     account_id: '699d98642c564d2e855e9661899b7252',
-   *     body: ['f174e90a-fafe-4643-bbbc-4a0ed4fc8415'],
-   *   },
-   * );
-   * ```
+   * @deprecated
    */
   create(
     params: RevokeCreateParams,

package/src/resources/zero-trust/devices/settings.ts

@@ -24,6 +24,26 @@ export class Settings extends APIResource {
     )._thenUnwrap((obj) => obj.result);
   }
 
+  /**
+   * Resets the current device settings for a Zero Trust account.
+   *
+   * @example
+   * ```ts
+   * const deviceSettings =
+   *   await client.zeroTrust.devices.settings.delete({
+   *     account_id: '699d98642c564d2e855e9661899b7252',
+   *   });
+   * ```
+   */
+  delete(params: SettingDeleteParams, options?: Core.RequestOptions): Core.APIPromise<DeviceSettings | null> {
+    const { account_id } = params;
+    return (
+      this._client.delete(`/accounts/${account_id}/devices/settings`, options) as Core.APIPromise<{
+        result: DeviceSettings | null;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
   /**
    * Patches the current device settings for a Zero Trust account.
    *
@@ -127,6 +147,10 @@ export interface SettingUpdateParams {
   use_zt_virtual_ip?: boolean;
 }
 
+export interface SettingDeleteParams {
+  account_id: string;
+}
+
 export interface SettingEditParams {
   /**
    * Path param:
@@ -168,6 +192,7 @@ export declare namespace Settings {
   export {
     type DeviceSettings as DeviceSettings,
     type SettingUpdateParams as SettingUpdateParams,
+    type SettingDeleteParams as SettingDeleteParams,
     type SettingEditParams as SettingEditParams,
     type SettingGetParams as SettingGetParams,
   };

package/src/resources/zero-trust/devices/unrevoke.ts

@@ -5,19 +5,14 @@ import * as Core from '../../../core';
 
 export class Unrevoke extends APIResource {
   /**
-   * Unrevokes a list of registrations.
+   * Unrevokes a list of devices. Not supported when
+   * [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/)
+   * is enabled.
    *
    * **Deprecated**: please use POST
    * /accounts/{account_id}/devices/registrations/unrevoke instead.
    *
-   * @example
-   * ```ts
-   * const unrevoke =
-   *   await client.zeroTrust.devices.unrevoke.create({
-   *     account_id: '699d98642c564d2e855e9661899b7252',
-   *     body: ['f174e90a-fafe-4643-bbbc-4a0ed4fc8415'],
-   *   });
-   * ```
+   * @deprecated
    */
   create(
     params: UnrevokeCreateParams,

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

@@ -12,6 +12,8 @@ import {
   TracerouteTestPercentilesResponse,
   TracerouteTests,
 } from './traceroute-tests';
+import * as WARPChangeEventsAPI from './warp-change-events';
+import { WARPChangeEventGetParams, WARPChangeEventGetResponse, WARPChangeEvents } from './warp-change-events';
 import * as CommandsAPI from './commands/commands';
 import {
   CommandCreateParams,
@@ -37,6 +39,9 @@ import * as TracerouteTestResultsAPI from './traceroute-test-results/traceroute-
 import { TracerouteTestResults } from './traceroute-test-results/traceroute-test-results';
 
 export class DEX extends APIResource {
+  warpChangeEvents: WARPChangeEventsAPI.WARPChangeEvents = new WARPChangeEventsAPI.WARPChangeEvents(
+    this._client,
+  );
   commands: CommandsAPI.Commands = new CommandsAPI.Commands(this._client);
   colos: ColosAPI.Colos = new ColosAPI.Colos(this._client);
   fleetStatus: FleetStatusAPI.FleetStatus = new FleetStatusAPI.FleetStatus(this._client);
@@ -158,6 +163,7 @@ export interface Percentiles {
   p99?: number | null;
 }
 
+DEX.WARPChangeEvents = WARPChangeEvents;
 DEX.Commands = Commands;
 DEX.CommandListResponsesV4PagePagination = CommandListResponsesV4PagePagination;
 DEX.Colos = Colos;
@@ -176,6 +182,12 @@ export declare namespace DEX {
     type Percentiles as Percentiles,
   };
 
+  export {
+    WARPChangeEvents as WARPChangeEvents,
+    type WARPChangeEventGetResponse as WARPChangeEventGetResponse,
+    type WARPChangeEventGetParams as WARPChangeEventGetParams,
+  };
+
   export {
     Commands as Commands,
     type CommandCreateResponse as CommandCreateResponse,

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

@@ -34,3 +34,8 @@ export {
   type TracerouteTestNetworkPathParams,
   type TracerouteTestPercentilesParams,
 } from './traceroute-tests';
+export {
+  WARPChangeEvents,
+  type WARPChangeEventGetResponse,
+  type WARPChangeEventGetParams,
+} from './warp-change-events';

package/src/resources/zero-trust/dex/warp-change-events.ts

@@ -0,0 +1,221 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+
+export class WARPChangeEvents extends APIResource {
+  /**
+   * List WARP configuration and enablement toggle change events by device.
+   *
+   * @example
+   * ```ts
+   * const warpChangeEvents =
+   *   await client.zeroTrust.dex.warpChangeEvents.get({
+   *     account_id: '01a7362d577a6c3019a474fd6f485823',
+   *     from: '2023-09-20T17:00:00Z',
+   *     page: 1,
+   *     per_page: 1,
+   *     to: '2023-09-20T17:00:00Z',
+   *   });
+   * ```
+   */
+  get(
+    params: WARPChangeEventGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<WARPChangeEventGetResponse> {
+    const { account_id, ...query } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/dex/warp-change-events`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: WARPChangeEventGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export type WARPChangeEventGetResponse = Array<
+  | WARPChangeEventGetResponse.DigitalExperienceMonitoringWARPToggleChangeEvent
+  | WARPChangeEventGetResponse.DigitalExperienceMonitoringWARPConfigChangeEvent
+>;
+
+export namespace WARPChangeEventGetResponse {
+  export interface DigitalExperienceMonitoringWARPToggleChangeEvent {
+    /**
+     * The account name.
+     */
+    account_name?: string;
+
+    /**
+     * The public account identifier.
+     */
+    account_tag?: string;
+
+    /**
+     * API Resource UUID tag.
+     */
+    device_id?: string;
+
+    /**
+     * API Resource UUID tag.
+     */
+    device_registration?: string;
+
+    /**
+     * The hostname of the machine the event is from
+     */
+    hostname?: string;
+
+    /**
+     * The serial number of the machine the event is from
+     */
+    serial_number?: string;
+
+    /**
+     * Timestamp in ISO format
+     */
+    timestamp?: string;
+
+    /**
+     * The state of the WARP toggle.
+     */
+    toggle?: 'on' | 'off';
+
+    /**
+     * Email tied to the device
+     */
+    user_email?: string;
+  }
+
+  export interface DigitalExperienceMonitoringWARPConfigChangeEvent {
+    /**
+     * API Resource UUID tag.
+     */
+    device_id?: string;
+
+    /**
+     * API Resource UUID tag.
+     */
+    device_registration?: string;
+
+    from?: DigitalExperienceMonitoringWARPConfigChangeEvent.From;
+
+    /**
+     * The hostname of the machine the event is from
+     */
+    hostname?: string;
+
+    /**
+     * The serial number of the machine the event is from
+     */
+    serial_number?: string;
+
+    /**
+     * Timestamp in ISO format
+     */
+    timestamp?: string;
+
+    to?: DigitalExperienceMonitoringWARPConfigChangeEvent.To;
+
+    /**
+     * Email tied to the device
+     */
+    user_email?: string;
+  }
+
+  export namespace DigitalExperienceMonitoringWARPConfigChangeEvent {
+    export interface From {
+      /**
+       * The account name.
+       */
+      account_name?: string;
+
+      /**
+       * API Resource UUID tag.
+       */
+      account_tag?: string;
+
+      /**
+       * The name of the WARP configuration.
+       */
+      config_name?: string;
+    }
+
+    export interface To {
+      /**
+       * The account name.
+       */
+      account_name?: string;
+
+      /**
+       * API Resource UUID tag.
+       */
+      account_tag?: string;
+
+      /**
+       * The name of the WARP configuration.
+       */
+      config_name?: string;
+    }
+  }
+}
+
+export interface WARPChangeEventGetParams {
+  /**
+   * Path param: unique identifier linked to an account in the API request path
+   */
+  account_id: string;
+
+  /**
+   * Query param: Start time for the query in ISO (RFC3339 - ISO 8601) format
+   */
+  from: string;
+
+  /**
+   * Query param: Page number of paginated results
+   */
+  page: number;
+
+  /**
+   * Query param: Number of items per page
+   */
+  per_page: number;
+
+  /**
+   * Query param: End time for the query in ISO (RFC3339 - ISO 8601) format
+   */
+  to: string;
+
+  /**
+   * Query param: Filter events by account name.
+   */
+  account_name?: string;
+
+  /**
+   * Query param: Filter events by WARP configuration name changed from or to.
+   * Applicable to type='config' events only.
+   */
+  config_name?: string;
+
+  /**
+   * Query param: Sort response by event timestamp.
+   */
+  sort_order?: 'ASC' | 'DESC';
+
+  /**
+   * Query param: Filter events by type toggle value. Applicable to type='toggle'
+   * events only.
+   */
+  toggle?: 'on' | 'off';
+
+  /**
+   * Query param: Filter events by type 'config' or 'toggle'
+   */
+  type?: 'config' | 'toggle';
+}
+
+export declare namespace WARPChangeEvents {
+  export {
+    type WARPChangeEventGetResponse as WARPChangeEventGetResponse,
+    type WARPChangeEventGetParams as WARPChangeEventGetParams,
+  };
+}

package/src/resources/zero-trust/dlp/entries.ts

@@ -156,6 +156,7 @@ export type EntryUpdateResponse =
   | EntryUpdateResponse.PredefinedEntry
   | EntryUpdateResponse.IntegrationEntry
   | EntryUpdateResponse.ExactDataEntry
+  | EntryUpdateResponse.DocumentTemplateEntry
   | EntryUpdateResponse.WordListEntry;
 
 export namespace EntryUpdateResponse {
@@ -244,6 +245,20 @@ export namespace EntryUpdateResponse {
     updated_at: string;
   }
 
+  export interface DocumentTemplateEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_template';
+
+    updated_at: string;
+  }
+
   export interface WordListEntry {
     id: string;
 
@@ -268,6 +283,7 @@ export type EntryListResponse =
   | EntryListResponse.PredefinedEntry
   | EntryListResponse.IntegrationEntry
   | EntryListResponse.ExactDataEntry
+  | EntryListResponse.DocumentTemplateEntry
   | EntryListResponse.WordListEntry;
 
 export namespace EntryListResponse {
@@ -356,6 +372,20 @@ export namespace EntryListResponse {
     updated_at: string;
   }
 
+  export interface DocumentTemplateEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_template';
+
+    updated_at: string;
+  }
+
   export interface WordListEntry {
     id: string;
 
@@ -382,6 +412,7 @@ export type EntryGetResponse =
   | EntryGetResponse.PredefinedEntry
   | EntryGetResponse.IntegrationEntry
   | EntryGetResponse.ExactDataEntry
+  | EntryGetResponse.DocumentTemplateEntry
   | EntryGetResponse.WordListEntry;
 
 export namespace EntryGetResponse {
@@ -470,6 +501,20 @@ export namespace EntryGetResponse {
     updated_at: string;
   }
 
+  export interface DocumentTemplateEntry {
+    id: string;
+
+    created_at: string;
+
+    enabled: boolean;
+
+    name: string;
+
+    type: 'document_template';
+
+    updated_at: string;
+  }
+
   export interface WordListEntry {
     id: string;