cloudflare 4.1.0 → 4.3.0

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

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class ConnectivitySettings extends APIResource {
   /**
    * Updates the Zero Trust Connectivity Settings for the given account.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.zeroTrust.connectivitySettings.edit({
+   *     account_id: '699d98642c564d2e855e9661899b7252',
+   *   });
+   * ```
    */
   edit(
     params: ConnectivitySettingEditParams,
@@ -22,6 +30,14 @@ export class ConnectivitySettings extends APIResource {
 
   /**
    * Gets the Zero Trust Connectivity Settings for the given account.
+   *
+   * @example
+   * ```ts
+   * const connectivitySetting =
+   *   await client.zeroTrust.connectivitySettings.get({
+   *     account_id: '699d98642c564d2e855e9661899b7252',
+   *   });
+   * ```
    */
   get(
     params: ConnectivitySettingGetParams,

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

@@ -2,20 +2,18 @@
 
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
-import * as DEXTestsAPI from './dex-tests';
+import * as DevicesDevicesAPI from './devices_';
 import {
-  DEXTest,
-  DEXTestCreateParams,
-  DEXTestDeleteParams,
-  DEXTestDeleteResponse,
-  DEXTestGetParams,
-  DEXTestListParams,
-  DEXTestUpdateParams,
-  DEXTests,
-  SchemaData,
-  SchemaHTTP,
-  SchemaHTTPSSinglePage,
-} from './dex-tests';
+  DeviceDeleteParams,
+  DeviceDeleteResponse,
+  DeviceListResponse,
+  DeviceListResponsesCursorPagination,
+  DeviceRevokeParams,
+  DeviceRevokeResponse,
+  Devices as DevicesAPIDevices,
+} from './devices_';
+import * as DEXTestsAPI from './dex-tests';
+import { DEXTests, SchemaData, SchemaHTTP } from './dex-tests';
 import * as FleetStatusAPI from './fleet-status';
 import { FleetStatus, FleetStatusGetParams, FleetStatusGetResponse } from './fleet-status';
 import * as NetworksAPI from './networks';
@@ -30,14 +28,38 @@ import {
   Networks,
 } from './networks';
 import * as OverrideCodesAPI from './override-codes';
-import { OverrideCodeListParams, OverrideCodeListResponse, OverrideCodes } from './override-codes';
+import {
+  OverrideCodeGetParams,
+  OverrideCodeGetResponse,
+  OverrideCodeListParams,
+  OverrideCodeListResponse,
+  OverrideCodeListResponsesSinglePage,
+  OverrideCodes,
+} from './override-codes';
+import * as RegistrationsAPI from './registrations';
+import {
+  RegistrationBulkDeleteParams,
+  RegistrationBulkDeleteResponse,
+  RegistrationDeleteParams,
+  RegistrationDeleteResponse,
+  RegistrationGetParams,
+  RegistrationGetResponse,
+  RegistrationListParams,
+  RegistrationListResponse,
+  RegistrationListResponsesCursorPagination,
+  RegistrationRevokeParams,
+  RegistrationRevokeResponse,
+  RegistrationUnrevokeParams,
+  RegistrationUnrevokeResponse,
+  Registrations,
+} from './registrations';
 import * as RevokeAPI from './revoke';
 import { Revoke, RevokeCreateParams, RevokeCreateResponse } from './revoke';
 import * as SettingsAPI from './settings';
 import {
   DeviceSettings,
   SettingEditParams,
-  SettingListParams,
+  SettingGetParams,
   SettingUpdateParams,
   Settings,
 } from './settings';
@@ -82,9 +104,14 @@ import {
   UniqueClientIDInput,
   WorkspaceOneInput,
 } from './posture/posture';
+import * as ResilienceAPI from './resilience/resilience';
+import { Resilience } from './resilience/resilience';
 import { SinglePage } from '../../../pagination';
 
 export class Devices extends APIResource {
+  devices: DevicesDevicesAPI.Devices = new DevicesDevicesAPI.Devices(this._client);
+  resilience: ResilienceAPI.Resilience = new ResilienceAPI.Resilience(this._client);
+  registrations: RegistrationsAPI.Registrations = new RegistrationsAPI.Registrations(this._client);
   dexTests: DEXTestsAPI.DEXTests = new DEXTestsAPI.DEXTests(this._client);
   networks: NetworksAPI.Networks = new NetworksAPI.Networks(this._client);
   fleetStatus: FleetStatusAPI.FleetStatus = new FleetStatusAPI.FleetStatus(this._client);
@@ -96,7 +123,22 @@ export class Devices extends APIResource {
   overrideCodes: OverrideCodesAPI.OverrideCodes = new OverrideCodesAPI.OverrideCodes(this._client);
 
   /**
-   * Fetches a list of enrolled devices.
+   * List WARP registrations.
+   *
+   * **Deprecated**: please use one of the following endpoints instead:
+   *
+   * - GET /accounts/{account_id}/devices/physical-devices
+   * - GET /accounts/{account_id}/devices/registrations
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const device of client.zeroTrust.devices.list({
+   *   account_id: '699d98642c564d2e855e9661899b7252',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(params: DeviceListParams, options?: Core.RequestOptions): Core.PagePromise<DevicesSinglePage, Device> {
     const { account_id } = params;
@@ -104,7 +146,20 @@ export class Devices extends APIResource {
   }
 
   /**
-   * Fetches details for a single device.
+   * Fetches a single WARP registration.
+   *
+   * **Deprecated**: please use one of the following endpoints instead:
+   *
+   * - GET /accounts/{account_id}/devices/physical-devices/{device_id}
+   * - GET /accounts/{account_id}/devices/registrations/{registration_id}
+   *
+   * @example
+   * ```ts
+   * const device = await client.zeroTrust.devices.get(
+   *   'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
+   *   { account_id: '699d98642c564d2e855e9661899b7252' },
+   * );
+   * ```
    */
   get(
     deviceId: string,
@@ -124,7 +179,8 @@ export class DevicesSinglePage extends SinglePage<Device> {}
 
 export interface Device {
   /**
-   * Device ID.
+   * Registration ID. Equal to Device ID except for accounts which enabled
+   * [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/).
    */
   id?: string;
 
@@ -138,7 +194,7 @@ export interface Device {
    */
   deleted?: boolean;
 
-  device_type?: 'windows' | 'mac' | 'linux' | 'android' | 'ios';
+  device_type?: 'windows' | 'mac' | 'linux' | 'android' | 'ios' | 'chromeos';
 
   /**
    * IPv4 or IPv6 address.
@@ -221,7 +277,7 @@ export interface Device {
 export namespace Device {
   export interface User {
     /**
-     * UUID
+     * UUID.
      */
     id?: string;
 
@@ -239,7 +295,8 @@ export namespace Device {
 
 export interface DeviceGetResponse {
   /**
-   * Device ID.
+   * Registration ID. Equal to Device ID except for accounts which enabled
+   * [multi-user mode](https://developers.cloudflare.com/cloudflare-one/connections/connect-devices/warp/deployment/mdm-deployment/windows-multiuser/).
    */
   id?: string;
 
@@ -345,7 +402,7 @@ export namespace DeviceGetResponse {
 
   export interface User {
     /**
-     * UUID
+     * UUID.
      */
     id?: string;
 
@@ -370,8 +427,12 @@ export interface DeviceGetParams {
 }
 
 Devices.DevicesSinglePage = DevicesSinglePage;
+Devices.Devices = DevicesAPIDevices;
+Devices.DeviceListResponsesCursorPagination = DeviceListResponsesCursorPagination;
+Devices.Resilience = Resilience;
+Devices.Registrations = Registrations;
+Devices.RegistrationListResponsesCursorPagination = RegistrationListResponsesCursorPagination;
 Devices.DEXTests = DEXTests;
-Devices.SchemaHTTPSSinglePage = SchemaHTTPSSinglePage;
 Devices.Networks = Networks;
 Devices.DeviceNetworksSinglePage = DeviceNetworksSinglePage;
 Devices.FleetStatus = FleetStatus;
@@ -382,6 +443,7 @@ Devices.Revoke = Revoke;
 Devices.Settings = Settings;
 Devices.Unrevoke = Unrevoke;
 Devices.OverrideCodes = OverrideCodes;
+Devices.OverrideCodeListResponsesSinglePage = OverrideCodeListResponsesSinglePage;
 
 export declare namespace Devices {
   export {
@@ -393,19 +455,36 @@ export declare namespace Devices {
   };
 
   export {
-    DEXTests as DEXTests,
-    type DEXTest as DEXTest,
-    type SchemaData as SchemaData,
-    type SchemaHTTP as SchemaHTTP,
-    type DEXTestDeleteResponse as DEXTestDeleteResponse,
-    SchemaHTTPSSinglePage as SchemaHTTPSSinglePage,
-    type DEXTestCreateParams as DEXTestCreateParams,
-    type DEXTestUpdateParams as DEXTestUpdateParams,
-    type DEXTestListParams as DEXTestListParams,
-    type DEXTestDeleteParams as DEXTestDeleteParams,
-    type DEXTestGetParams as DEXTestGetParams,
+    DevicesAPIDevices as Devices,
+    type DeviceListResponse as DeviceListResponse,
+    type DeviceDeleteResponse as DeviceDeleteResponse,
+    type DeviceRevokeResponse as DeviceRevokeResponse,
+    DeviceListResponsesCursorPagination as DeviceListResponsesCursorPagination,
+    type DeviceDeleteParams as DeviceDeleteParams,
+    type DeviceRevokeParams as DeviceRevokeParams,
   };
 
+  export { Resilience as Resilience };
+
+  export {
+    Registrations as Registrations,
+    type RegistrationListResponse as RegistrationListResponse,
+    type RegistrationDeleteResponse as RegistrationDeleteResponse,
+    type RegistrationBulkDeleteResponse as RegistrationBulkDeleteResponse,
+    type RegistrationGetResponse as RegistrationGetResponse,
+    type RegistrationRevokeResponse as RegistrationRevokeResponse,
+    type RegistrationUnrevokeResponse as RegistrationUnrevokeResponse,
+    RegistrationListResponsesCursorPagination as RegistrationListResponsesCursorPagination,
+    type RegistrationListParams as RegistrationListParams,
+    type RegistrationDeleteParams as RegistrationDeleteParams,
+    type RegistrationBulkDeleteParams as RegistrationBulkDeleteParams,
+    type RegistrationGetParams as RegistrationGetParams,
+    type RegistrationRevokeParams as RegistrationRevokeParams,
+    type RegistrationUnrevokeParams as RegistrationUnrevokeParams,
+  };
+
+  export { DEXTests as DEXTests, type SchemaData as SchemaData, type SchemaHTTP as SchemaHTTP };
+
   export {
     Networks as Networks,
     type DeviceNetwork as DeviceNetwork,
@@ -472,8 +551,8 @@ export declare namespace Devices {
     Settings as Settings,
     type DeviceSettings as DeviceSettings,
     type SettingUpdateParams as SettingUpdateParams,
-    type SettingListParams as SettingListParams,
     type SettingEditParams as SettingEditParams,
+    type SettingGetParams as SettingGetParams,
   };
 
   export {
@@ -485,6 +564,9 @@ export declare namespace Devices {
   export {
     OverrideCodes as OverrideCodes,
     type OverrideCodeListResponse as OverrideCodeListResponse,
+    type OverrideCodeGetResponse as OverrideCodeGetResponse,
+    OverrideCodeListResponsesSinglePage as OverrideCodeListResponsesSinglePage,
     type OverrideCodeListParams as OverrideCodeListParams,
+    type OverrideCodeGetParams as OverrideCodeGetParams,
   };
 }