cloudflare 5.1.0 → 6.0.0-beta.1

package/src/resources/leaked-credential-checks/detections.ts

@@ -105,6 +105,32 @@ export class Detections extends APIResource {
       ) as Core.APIPromise<{ result: DetectionDeleteResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
+
+  /**
+   * Get user-defined detection pattern for Leaked Credential Checks.
+   *
+   * @example
+   * ```ts
+   * const detection =
+   *   await client.leakedCredentialChecks.detections.get(
+   *     '18a14bafaa8eb1df04ce683ec18c765e',
+   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    detectionId: string,
+    params: DetectionGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DetectionGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(
+        `/zones/${zone_id}/leaked-credential-checks/detections/${detectionId}`,
+        options,
+      ) as Core.APIPromise<{ result: DetectionGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
 }
 
 export class DetectionListResponsesSinglePage extends SinglePage<DetectionListResponse> {}
@@ -174,6 +200,27 @@ export interface DetectionListResponse {
 
 export type DetectionDeleteResponse = unknown;
 
+/**
+ * Defines a custom set of username/password expressions to match Leaked Credential
+ * Checks on.
+ */
+export interface DetectionGetResponse {
+  /**
+   * Defines the unique ID for this custom detection.
+   */
+  id?: string;
+
+  /**
+   * Defines ehe ruleset expression to use in matching the password in a request.
+   */
+  password?: string;
+
+  /**
+   * Defines the ruleset expression to use in matching the username in a request.
+   */
+  username?: string;
+}
+
 export interface DetectionCreateParams {
   /**
    * Path param: Defines an identifier.
@@ -226,6 +273,13 @@ export interface DetectionDeleteParams {
   zone_id: string;
 }
 
+export interface DetectionGetParams {
+  /**
+   * Defines an identifier.
+   */
+  zone_id: string;
+}
+
 Detections.DetectionListResponsesSinglePage = DetectionListResponsesSinglePage;
 
 export declare namespace Detections {
@@ -234,10 +288,12 @@ export declare namespace Detections {
     type DetectionUpdateResponse as DetectionUpdateResponse,
     type DetectionListResponse as DetectionListResponse,
     type DetectionDeleteResponse as DetectionDeleteResponse,
+    type DetectionGetResponse as DetectionGetResponse,
     DetectionListResponsesSinglePage as DetectionListResponsesSinglePage,
     type DetectionCreateParams as DetectionCreateParams,
     type DetectionUpdateParams as DetectionUpdateParams,
     type DetectionListParams as DetectionListParams,
     type DetectionDeleteParams as DetectionDeleteParams,
+    type DetectionGetParams as DetectionGetParams,
   };
 }

package/src/resources/leaked-credential-checks/index.ts

@@ -7,9 +7,11 @@ export {
   type DetectionUpdateResponse,
   type DetectionListResponse,
   type DetectionDeleteResponse,
+  type DetectionGetResponse,
   type DetectionCreateParams,
   type DetectionUpdateParams,
   type DetectionListParams,
   type DetectionDeleteParams,
+  type DetectionGetParams,
 } from './detections';
 export { LeakedCredentialChecks } from './leaked-credential-checks';

package/src/resources/leaked-credential-checks/leaked-credential-checks.ts

@@ -8,6 +8,8 @@ import {
   DetectionCreateResponse,
   DetectionDeleteParams,
   DetectionDeleteResponse,
+  DetectionGetParams,
+  DetectionGetResponse,
   DetectionListParams,
   DetectionListResponse,
   DetectionListResponsesSinglePage,
@@ -123,10 +125,12 @@ export declare namespace LeakedCredentialChecks {
     type DetectionUpdateResponse as DetectionUpdateResponse,
     type DetectionListResponse as DetectionListResponse,
     type DetectionDeleteResponse as DetectionDeleteResponse,
+    type DetectionGetResponse as DetectionGetResponse,
     DetectionListResponsesSinglePage as DetectionListResponsesSinglePage,
     type DetectionCreateParams as DetectionCreateParams,
     type DetectionUpdateParams as DetectionUpdateParams,
     type DetectionListParams as DetectionListParams,
     type DetectionDeleteParams as DetectionDeleteParams,
+    type DetectionGetParams as DetectionGetParams,
   };
 }

package/src/resources/load-balancers/index.ts

@@ -1,6 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { LoadBalancers } from './load-balancers';
+export {
+  MonitorGroupsSinglePage,
+  MonitorGroups,
+  type MonitorGroup,
+  type MonitorGroupCreateParams,
+  type MonitorGroupUpdateParams,
+  type MonitorGroupListParams,
+  type MonitorGroupDeleteParams,
+  type MonitorGroupEditParams,
+  type MonitorGroupGetParams,
+} from './monitor-groups';
 export {
   MonitorsSinglePage,
   Monitors,

package/src/resources/load-balancers/load-balancers.ts

@@ -3,6 +3,18 @@
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as LoadBalancersAPI from './load-balancers';
+import * as MonitorGroupsAPI from './monitor-groups';
+import {
+  MonitorGroup,
+  MonitorGroupCreateParams,
+  MonitorGroupDeleteParams,
+  MonitorGroupEditParams,
+  MonitorGroupGetParams,
+  MonitorGroupListParams,
+  MonitorGroupUpdateParams,
+  MonitorGroups,
+  MonitorGroupsSinglePage,
+} from './monitor-groups';
 import * as PreviewsAPI from './previews';
 import { PreviewGetParams, PreviewGetResponse, Previews } from './previews';
 import * as RegionsAPI from './regions';
@@ -45,6 +57,7 @@ import { SinglePage } from '../../pagination';
 
 export class LoadBalancers extends APIResource {
   monitors: MonitorsAPI.Monitors = new MonitorsAPI.Monitors(this._client);
+  monitorGroups: MonitorGroupsAPI.MonitorGroups = new MonitorGroupsAPI.MonitorGroups(this._client);
   pools: PoolsAPI.Pools = new PoolsAPI.Pools(this._client);
   previews: PreviewsAPI.Previews = new PreviewsAPI.Previews(this._client);
   regions: RegionsAPI.Regions = new RegionsAPI.Regions(this._client);
@@ -2132,6 +2145,8 @@ export interface LoadBalancerGetParams {
 LoadBalancers.LoadBalancersSinglePage = LoadBalancersSinglePage;
 LoadBalancers.Monitors = Monitors;
 LoadBalancers.MonitorsSinglePage = MonitorsSinglePage;
+LoadBalancers.MonitorGroups = MonitorGroups;
+LoadBalancers.MonitorGroupsSinglePage = MonitorGroupsSinglePage;
 LoadBalancers.Pools = Pools;
 LoadBalancers.PoolsSinglePage = PoolsSinglePage;
 LoadBalancers.Previews = Previews;
@@ -2181,6 +2196,18 @@ export declare namespace LoadBalancers {
     type MonitorGetParams as MonitorGetParams,
   };
 
+  export {
+    MonitorGroups as MonitorGroups,
+    type MonitorGroup as MonitorGroup,
+    MonitorGroupsSinglePage as MonitorGroupsSinglePage,
+    type MonitorGroupCreateParams as MonitorGroupCreateParams,
+    type MonitorGroupUpdateParams as MonitorGroupUpdateParams,
+    type MonitorGroupListParams as MonitorGroupListParams,
+    type MonitorGroupDeleteParams as MonitorGroupDeleteParams,
+    type MonitorGroupEditParams as MonitorGroupEditParams,
+    type MonitorGroupGetParams as MonitorGroupGetParams,
+  };
+
   export {
     Pools as Pools,
     type Pool as Pool,

package/src/resources/load-balancers/monitor-groups.ts

@@ -0,0 +1,436 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import { SinglePage } from '../../pagination';
+
+export class MonitorGroups extends APIResource {
+  /**
+   * Create a new monitor group.
+   *
+   * @example
+   * ```ts
+   * const monitorGroup =
+   *   await client.loadBalancers.monitorGroups.create({
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     id: 'id',
+   *     description: 'Primary datacenter monitors',
+   *     members: [
+   *       {
+   *         enabled: true,
+   *         monitor_id: 'monitor_id',
+   *         monitoring_only: false,
+   *         must_be_healthy: true,
+   *       },
+   *     ],
+   *   });
+   * ```
+   */
+  create(params: MonitorGroupCreateParams, options?: Core.RequestOptions): Core.APIPromise<MonitorGroup> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.post(`/accounts/${account_id}/load_balancers/monitor_groups`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: MonitorGroup }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Modify a configured monitor group.
+   *
+   * @example
+   * ```ts
+   * const monitorGroup =
+   *   await client.loadBalancers.monitorGroups.update(
+   *     '17b5962d775c646f3f9725cbc7a53df4',
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       id: 'id',
+   *       description: 'Primary datacenter monitors',
+   *       members: [
+   *         {
+   *           enabled: true,
+   *           monitor_id: 'monitor_id',
+   *           monitoring_only: false,
+   *           must_be_healthy: true,
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
+   */
+  update(
+    monitorGroupId: string,
+    params: MonitorGroupUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MonitorGroup> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.put(`/accounts/${account_id}/load_balancers/monitor_groups/${monitorGroupId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: MonitorGroup }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * List configured monitor groups.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const monitorGroup of client.loadBalancers.monitorGroups.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: MonitorGroupListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<MonitorGroupsSinglePage, MonitorGroup> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/load_balancers/monitor_groups`,
+      MonitorGroupsSinglePage,
+      options,
+    );
+  }
+
+  /**
+   * Delete a configured monitor group.
+   *
+   * @example
+   * ```ts
+   * const monitorGroup =
+   *   await client.loadBalancers.monitorGroups.delete(
+   *     '17b5962d775c646f3f9725cbc7a53df4',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  delete(
+    monitorGroupId: string,
+    params: MonitorGroupDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MonitorGroup> {
+    const { account_id } = params;
+    return (
+      this._client.delete(
+        `/accounts/${account_id}/load_balancers/monitor_groups/${monitorGroupId}`,
+        options,
+      ) as Core.APIPromise<{ result: MonitorGroup }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Apply changes to an existing monitor group, overwriting the supplied properties.
+   *
+   * @example
+   * ```ts
+   * const monitorGroup =
+   *   await client.loadBalancers.monitorGroups.edit(
+   *     '17b5962d775c646f3f9725cbc7a53df4',
+   *     {
+   *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *       id: 'id',
+   *       description: 'Primary datacenter monitors',
+   *       members: [
+   *         {
+   *           enabled: true,
+   *           monitor_id: 'monitor_id',
+   *           monitoring_only: false,
+   *           must_be_healthy: true,
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
+   */
+  edit(
+    monitorGroupId: string,
+    params: MonitorGroupEditParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MonitorGroup> {
+    const { account_id, ...body } = params;
+    return (
+      this._client.patch(`/accounts/${account_id}/load_balancers/monitor_groups/${monitorGroupId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: MonitorGroup }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Fetch a single configured monitor group.
+   *
+   * @example
+   * ```ts
+   * const monitorGroup =
+   *   await client.loadBalancers.monitorGroups.get(
+   *     '17b5962d775c646f3f9725cbc7a53df4',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   *   );
+   * ```
+   */
+  get(
+    monitorGroupId: string,
+    params: MonitorGroupGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<MonitorGroup> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/load_balancers/monitor_groups/${monitorGroupId}`,
+        options,
+      ) as Core.APIPromise<{ result: MonitorGroup }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class MonitorGroupsSinglePage extends SinglePage<MonitorGroup> {}
+
+export interface MonitorGroup {
+  /**
+   * The ID of the Monitor Group to use for checking the health of origins within
+   * this pool.
+   */
+  id: string;
+
+  /**
+   * A short description of the monitor group
+   */
+  description: string;
+
+  /**
+   * List of monitors in this group
+   */
+  members: Array<MonitorGroup.Member>;
+
+  /**
+   * The timestamp of when the monitor group was created
+   */
+  created_at?: string;
+
+  /**
+   * The timestamp of when the monitor group was last updated
+   */
+  updated_at?: string;
+}
+
+export namespace MonitorGroup {
+  export interface Member {
+    /**
+     * Whether this monitor is enabled in the group
+     */
+    enabled: boolean;
+
+    /**
+     * The ID of the Monitor to use for checking the health of origins within this
+     * pool.
+     */
+    monitor_id: string;
+
+    /**
+     * Whether this monitor is used for monitoring only (does not affect pool health)
+     */
+    monitoring_only: boolean;
+
+    /**
+     * Whether this monitor must be healthy for the pool to be considered healthy
+     */
+    must_be_healthy: boolean;
+
+    /**
+     * The timestamp of when the monitor was added to the group
+     */
+    created_at?: string;
+
+    /**
+     * The timestamp of when the monitor group member was last updated
+     */
+    updated_at?: string;
+  }
+}
+
+export interface MonitorGroupCreateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The ID of the Monitor Group to use for checking the health of
+   * origins within this pool.
+   */
+  id: string;
+
+  /**
+   * Body param: A short description of the monitor group
+   */
+  description: string;
+
+  /**
+   * Body param: List of monitors in this group
+   */
+  members: Array<MonitorGroupCreateParams.Member>;
+}
+
+export namespace MonitorGroupCreateParams {
+  export interface Member {
+    /**
+     * Whether this monitor is enabled in the group
+     */
+    enabled: boolean;
+
+    /**
+     * The ID of the Monitor to use for checking the health of origins within this
+     * pool.
+     */
+    monitor_id: string;
+
+    /**
+     * Whether this monitor is used for monitoring only (does not affect pool health)
+     */
+    monitoring_only: boolean;
+
+    /**
+     * Whether this monitor must be healthy for the pool to be considered healthy
+     */
+    must_be_healthy: boolean;
+  }
+}
+
+export interface MonitorGroupUpdateParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The ID of the Monitor Group to use for checking the health of
+   * origins within this pool.
+   */
+  id: string;
+
+  /**
+   * Body param: A short description of the monitor group
+   */
+  description: string;
+
+  /**
+   * Body param: List of monitors in this group
+   */
+  members: Array<MonitorGroupUpdateParams.Member>;
+}
+
+export namespace MonitorGroupUpdateParams {
+  export interface Member {
+    /**
+     * Whether this monitor is enabled in the group
+     */
+    enabled: boolean;
+
+    /**
+     * The ID of the Monitor to use for checking the health of origins within this
+     * pool.
+     */
+    monitor_id: string;
+
+    /**
+     * Whether this monitor is used for monitoring only (does not affect pool health)
+     */
+    monitoring_only: boolean;
+
+    /**
+     * Whether this monitor must be healthy for the pool to be considered healthy
+     */
+    must_be_healthy: boolean;
+  }
+}
+
+export interface MonitorGroupListParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface MonitorGroupDeleteParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+export interface MonitorGroupEditParams {
+  /**
+   * Path param: Identifier.
+   */
+  account_id: string;
+
+  /**
+   * Body param: The ID of the Monitor Group to use for checking the health of
+   * origins within this pool.
+   */
+  id: string;
+
+  /**
+   * Body param: A short description of the monitor group
+   */
+  description: string;
+
+  /**
+   * Body param: List of monitors in this group
+   */
+  members: Array<MonitorGroupEditParams.Member>;
+}
+
+export namespace MonitorGroupEditParams {
+  export interface Member {
+    /**
+     * Whether this monitor is enabled in the group
+     */
+    enabled: boolean;
+
+    /**
+     * The ID of the Monitor to use for checking the health of origins within this
+     * pool.
+     */
+    monitor_id: string;
+
+    /**
+     * Whether this monitor is used for monitoring only (does not affect pool health)
+     */
+    monitoring_only: boolean;
+
+    /**
+     * Whether this monitor must be healthy for the pool to be considered healthy
+     */
+    must_be_healthy: boolean;
+  }
+}
+
+export interface MonitorGroupGetParams {
+  /**
+   * Identifier.
+   */
+  account_id: string;
+}
+
+MonitorGroups.MonitorGroupsSinglePage = MonitorGroupsSinglePage;
+
+export declare namespace MonitorGroups {
+  export {
+    type MonitorGroup as MonitorGroup,
+    MonitorGroupsSinglePage as MonitorGroupsSinglePage,
+    type MonitorGroupCreateParams as MonitorGroupCreateParams,
+    type MonitorGroupUpdateParams as MonitorGroupUpdateParams,
+    type MonitorGroupListParams as MonitorGroupListParams,
+    type MonitorGroupDeleteParams as MonitorGroupDeleteParams,
+    type MonitorGroupEditParams as MonitorGroupEditParams,
+    type MonitorGroupGetParams as MonitorGroupGetParams,
+  };
+}

package/src/resources/load-balancers/monitors/monitors.ts

@@ -240,7 +240,7 @@ export interface Monitor {
    * SMTP checks. HTTP and HTTPS checks should only define the port when using a
    * non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Assign this monitor to emulate the specified zone while probing. This parameter
@@ -350,7 +350,7 @@ export interface MonitorCreateParams {
    * TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
    * when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Body param: Assign this monitor to emulate the specified zone while probing.
@@ -456,7 +456,7 @@ export interface MonitorUpdateParams {
    * TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
    * when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Body param: Assign this monitor to emulate the specified zone while probing.
@@ -576,7 +576,7 @@ export interface MonitorEditParams {
    * TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
    * when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Body param: Assign this monitor to emulate the specified zone while probing.

package/src/resources/load-balancers/monitors/previews.ts

@@ -121,7 +121,7 @@ export interface PreviewCreateParams {
    * TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
    * when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Body param: Assign this monitor to emulate the specified zone while probing.

package/src/resources/load-balancers/pools/health.ts

@@ -206,7 +206,7 @@ export interface HealthCreateParams {
    * TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
    * when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    */
-  port?: number;
+  port?: number | null;
 
   /**
    * Body param: Assign this monitor to emulate the specified zone while probing.