cloudflare 6.4.0 → 6.5.0

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

@@ -278,20 +278,20 @@ export interface Organization {
    */
   mfa_config?: Organization.MfaConfig;
 
+  /**
+   * Configures PIV key requirements for MFA using hardware security keys.
+   */
+  mfa_piv_key_requirements?: Organization.MfaPivKeyRequirements;
+
   /**
    * Determines whether global MFA settings apply to applications by default. The
    * organization must have MFA enabled with at least one authentication method and a
    * session duration configured. Note: 'allowed_authenticators' cannot only contain
-   * 'ssh_piv_key' if the organization has any non-infrastructure applications
-   * because PIV keys are only compatible with infrastructure apps.
+   * 'piv_key' if the organization has any non-infrastructure applications because
+   * PIV keys are only compatible with infrastructure apps.
    */
   mfa_required_for_all_apps?: boolean;
 
-  /**
-   * Configures SSH PIV key requirements for MFA using hardware security keys.
-   */
-  mfa_ssh_piv_key_requirements?: Organization.MfaSSHPivKeyRequirements;
-
   /**
    * The name of your Zero Trust organization.
    */
@@ -346,7 +346,7 @@ export namespace Organization {
     /**
      * Lists the MFA methods that users can authenticate with.
      */
-    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'ssh_piv_key'>;
+    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'piv_key'>;
 
     /**
      * Allows a user to skip MFA via Authentication Method Reference (AMR) matching
@@ -369,9 +369,9 @@ export namespace Organization {
   }
 
   /**
-   * Configures SSH PIV key requirements for MFA using hardware security keys.
+   * Configures PIV key requirements for MFA using hardware security keys.
    */
-  export interface MfaSSHPivKeyRequirements {
+  export interface MfaPivKeyRequirements {
     /**
      * Defines when a PIN is required to use the SSH key. Valid values: `never` (no PIN
      * required), `once` (PIN required once per session), `always` (PIN required for
@@ -380,8 +380,8 @@ export namespace Organization {
     pin_policy?: 'never' | 'once' | 'always';
 
     /**
-     * Requires the SSH PIV key to be stored on a FIPS 140-2 Level 1 or higher
-     * validated device.
+     * Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated
+     * device.
      */
     require_fips_device?: boolean;
 
@@ -480,21 +480,21 @@ export interface OrganizationCreateParams {
    */
   mfa_config?: OrganizationCreateParams.MfaConfig;
 
+  /**
+   * Body param: Configures PIV key requirements for MFA using hardware security
+   * keys.
+   */
+  mfa_piv_key_requirements?: OrganizationCreateParams.MfaPivKeyRequirements;
+
   /**
    * Body param: Determines whether global MFA settings apply to applications by
    * default. The organization must have MFA enabled with at least one authentication
    * method and a session duration configured. Note: 'allowed_authenticators' cannot
-   * only contain 'ssh_piv_key' if the organization has any non-infrastructure
+   * only contain 'piv_key' if the organization has any non-infrastructure
    * applications because PIV keys are only compatible with infrastructure apps.
    */
   mfa_required_for_all_apps?: boolean;
 
-  /**
-   * Body param: Configures SSH PIV key requirements for MFA using hardware security
-   * keys.
-   */
-  mfa_ssh_piv_key_requirements?: OrganizationCreateParams.MfaSSHPivKeyRequirements;
-
   /**
    * Body param: The amount of time that tokens issued for applications will be
    * valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us
@@ -532,7 +532,7 @@ export namespace OrganizationCreateParams {
     /**
      * Lists the MFA methods that users can authenticate with.
      */
-    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'ssh_piv_key'>;
+    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'piv_key'>;
 
     /**
      * Allows a user to skip MFA via Authentication Method Reference (AMR) matching
@@ -555,9 +555,9 @@ export namespace OrganizationCreateParams {
   }
 
   /**
-   * Configures SSH PIV key requirements for MFA using hardware security keys.
+   * Configures PIV key requirements for MFA using hardware security keys.
    */
-  export interface MfaSSHPivKeyRequirements {
+  export interface MfaPivKeyRequirements {
     /**
      * Defines when a PIN is required to use the SSH key. Valid values: `never` (no PIN
      * required), `once` (PIN required once per session), `always` (PIN required for
@@ -566,8 +566,8 @@ export namespace OrganizationCreateParams {
     pin_policy?: 'never' | 'once' | 'always';
 
     /**
-     * Requires the SSH PIV key to be stored on a FIPS 140-2 Level 1 or higher
-     * validated device.
+     * Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated
+     * device.
      */
     require_fips_device?: boolean;
 
@@ -664,21 +664,21 @@ export interface OrganizationUpdateParams {
    */
   mfa_config?: OrganizationUpdateParams.MfaConfig;
 
+  /**
+   * Body param: Configures PIV key requirements for MFA using hardware security
+   * keys.
+   */
+  mfa_piv_key_requirements?: OrganizationUpdateParams.MfaPivKeyRequirements;
+
   /**
    * Body param: Determines whether global MFA settings apply to applications by
    * default. The organization must have MFA enabled with at least one authentication
    * method and a session duration configured. Note: 'allowed_authenticators' cannot
-   * only contain 'ssh_piv_key' if the organization has any non-infrastructure
+   * only contain 'piv_key' if the organization has any non-infrastructure
    * applications because PIV keys are only compatible with infrastructure apps.
    */
   mfa_required_for_all_apps?: boolean;
 
-  /**
-   * Body param: Configures SSH PIV key requirements for MFA using hardware security
-   * keys.
-   */
-  mfa_ssh_piv_key_requirements?: OrganizationUpdateParams.MfaSSHPivKeyRequirements;
-
   /**
    * Body param: The name of your Zero Trust organization.
    */
@@ -734,7 +734,7 @@ export namespace OrganizationUpdateParams {
     /**
      * Lists the MFA methods that users can authenticate with.
      */
-    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'ssh_piv_key'>;
+    allowed_authenticators?: Array<'totp' | 'biometrics' | 'security_key' | 'piv_key'>;
 
     /**
      * Allows a user to skip MFA via Authentication Method Reference (AMR) matching
@@ -757,9 +757,9 @@ export namespace OrganizationUpdateParams {
   }
 
   /**
-   * Configures SSH PIV key requirements for MFA using hardware security keys.
+   * Configures PIV key requirements for MFA using hardware security keys.
    */
-  export interface MfaSSHPivKeyRequirements {
+  export interface MfaPivKeyRequirements {
     /**
      * Defines when a PIN is required to use the SSH key. Valid values: `never` (no PIN
      * required), `once` (PIN required once per session), `always` (PIN required for
@@ -768,8 +768,8 @@ export namespace OrganizationUpdateParams {
     pin_policy?: 'never' | 'once' | 'always';
 
     /**
-     * Requires the SSH PIV key to be stored on a FIPS 140-2 Level 1 or higher
-     * validated device.
+     * Requires the PIV key to be stored on a FIPS 140-2 Level 1 or higher validated
+     * device.
      */
     require_fips_device?: boolean;
 

package/src/resources/zones/api.md

@@ -165,3 +165,17 @@ Types:
 Methods:
 
 - <code title="get /zones/{zone_id}/available_rate_plans">client.zones.ratePlans.<a href="./src/resources/zones/rate-plans.ts">get</a>({ ...params }) -> RatePlanGetResponsesSinglePage</code>
+
+## CT
+
+### Alerting
+
+Types:
+
+- <code><a href="./src/resources/zones/ct/alerting.ts">AlertingEditResponse</a></code>
+- <code><a href="./src/resources/zones/ct/alerting.ts">AlertingGetResponse</a></code>
+
+Methods:
+
+- <code title="patch /zones/{zone_id}/ct/alerting">client.zones.ct.alerting.<a href="./src/resources/zones/ct/alerting.ts">edit</a>({ ...params }) -> AlertingEditResponse</code>
+- <code title="get /zones/{zone_id}/ct/alerting">client.zones.ct.alerting.<a href="./src/resources/zones/ct/alerting.ts">get</a>({ ...params }) -> AlertingGetResponse</code>

package/src/resources/zones/ct/alerting.ts

@@ -0,0 +1,126 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as Core from '../../../core';
+
+export class Alerting extends APIResource {
+  /**
+   * Create or update the Certificate Transparency alerting subscription for a zone.
+   * Enables or disables email notifications when certificates are issued for the
+   * zone's domains. For Free and Pro zones, the subscription is toggled on or off
+   * using the enabled field. Notification emails are sent to all users with SSL
+   * permissions on the zone. For Business and Enterprise zones, the emails field is
+   * required and controls which addresses receive alerts. Setting emails to an empty
+   * list disables the subscription regardless of the enabled field. A maximum of 10
+   * email addresses may be configured.
+   *
+   * @example
+   * ```ts
+   * const response = await client.zones.ct.alerting.edit({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   enabled: true,
+   * });
+   * ```
+   */
+  edit(params: AlertingEditParams, options?: Core.RequestOptions): Core.APIPromise<AlertingEditResponse> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.patch(`/zones/${zone_id}/ct/alerting`, { body, ...options }) as Core.APIPromise<{
+        result: AlertingEditResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Retrieve the Certificate Transparency alerting subscription settings for a zone.
+   * Returns whether CT monitoring is enabled and, for Business and Enterprise zones,
+   * the list of email addresses that receive alerts.
+   *
+   * @example
+   * ```ts
+   * const alerting = await client.zones.ct.alerting.get({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   * });
+   * ```
+   */
+  get(params: AlertingGetParams, options?: Core.RequestOptions): Core.APIPromise<AlertingGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/ct/alerting`, options) as Core.APIPromise<{
+        result: AlertingGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+/**
+ * Certificate Transparency alerting subscription settings for a zone.
+ */
+export interface AlertingEditResponse {
+  /**
+   * Whether CT alerting is enabled for the zone.
+   */
+  enabled: boolean;
+
+  /**
+   * Email addresses that receive CT alert notifications. Only present and
+   * configurable for Business and Enterprise zones. Maximum of 10 addresses. For
+   * Free and Pro zones, notifications are sent to all users with SSL permissions on
+   * the zone.
+   */
+  emails?: Array<string>;
+}
+
+/**
+ * Certificate Transparency alerting subscription settings for a zone.
+ */
+export interface AlertingGetResponse {
+  /**
+   * Whether CT alerting is enabled for the zone.
+   */
+  enabled: boolean;
+
+  /**
+   * Email addresses that receive CT alert notifications. Only present and
+   * configurable for Business and Enterprise zones. Maximum of 10 addresses. For
+   * Free and Pro zones, notifications are sent to all users with SSL permissions on
+   * the zone.
+   */
+  emails?: Array<string>;
+}
+
+export interface AlertingEditParams {
+  /**
+   * Path param: Identifier.
+   */
+  zone_id: string;
+
+  /**
+   * Body param: Whether CT alerting is enabled for the zone.
+   */
+  enabled: boolean;
+
+  /**
+   * Body param: Email addresses that receive CT alert notifications. Only present
+   * and configurable for Business and Enterprise zones. Maximum of 10 addresses. For
+   * Free and Pro zones, notifications are sent to all users with SSL permissions on
+   * the zone.
+   */
+  emails?: Array<string>;
+}
+
+export interface AlertingGetParams {
+  /**
+   * Identifier.
+   */
+  zone_id: string;
+}
+
+export declare namespace Alerting {
+  export {
+    type AlertingEditResponse as AlertingEditResponse,
+    type AlertingGetResponse as AlertingGetResponse,
+    type AlertingEditParams as AlertingEditParams,
+    type AlertingGetParams as AlertingGetParams,
+  };
+}

package/src/resources/zones/ct/ct.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import * as AlertingAPI from './alerting';
+import {
+  Alerting,
+  AlertingEditParams,
+  AlertingEditResponse,
+  AlertingGetParams,
+  AlertingGetResponse,
+} from './alerting';
+
+export class CT extends APIResource {
+  alerting: AlertingAPI.Alerting = new AlertingAPI.Alerting(this._client);
+}
+
+CT.Alerting = Alerting;
+
+export declare namespace CT {
+  export {
+    Alerting as Alerting,
+    type AlertingEditResponse as AlertingEditResponse,
+    type AlertingGetResponse as AlertingGetResponse,
+    type AlertingEditParams as AlertingEditParams,
+    type AlertingGetParams as AlertingGetParams,
+  };
+}

package/src/resources/zones/ct/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Alerting,
+  type AlertingEditResponse,
+  type AlertingGetResponse,
+  type AlertingEditParams,
+  type AlertingGetParams,
+} from './alerting';
+export { CT } from './ct';

package/src/resources/zones/ct.ts

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

package/src/resources/zones/index.ts

@@ -12,6 +12,7 @@ export {
   type PlanListParams,
   type PlanGetParams,
 } from './plans';
+export { CT } from './ct/index';
 export {
   CustomNameserverUpdateResponsesSinglePage,
   CustomNameservers,

package/src/resources/zones/zones.ts

@@ -119,6 +119,8 @@ import {
   SubscriptionUpdateResponse,
   Subscriptions,
 } from './subscriptions';
+import * as CTAPI from './ct/ct';
+import { CT } from './ct/ct';
 import { V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../pagination';
 
 export class Zones extends APIResource {
@@ -132,6 +134,7 @@ export class Zones extends APIResource {
   subscriptions: SubscriptionsAPI.Subscriptions = new SubscriptionsAPI.Subscriptions(this._client);
   plans: PlansAPI.Plans = new PlansAPI.Plans(this._client);
   ratePlans: RatePlansAPI.RatePlans = new RatePlansAPI.RatePlans(this._client);
+  ct: CTAPI.CT = new CTAPI.CT(this._client);
 
   /**
    * Create Zone
@@ -694,6 +697,7 @@ Zones.Plans = Plans;
 Zones.AvailableRatePlansSinglePage = AvailableRatePlansSinglePage;
 Zones.RatePlans = RatePlans;
 Zones.RatePlanGetResponsesSinglePage = RatePlanGetResponsesSinglePage;
+Zones.CT = CT;
 
 export declare namespace Zones {
   export {
@@ -830,4 +834,6 @@ export declare namespace Zones {
     RatePlanGetResponsesSinglePage as RatePlanGetResponsesSinglePage,
     type RatePlanGetParams as RatePlanGetParams,
   };
+
+  export { CT as CT };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.4.0'; // x-release-please-version
+export const VERSION = '6.5.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.4.0";
+export declare const VERSION = "6.5.0";
 //# 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 = '6.4.0'; // x-release-please-version
+exports.VERSION = '6.5.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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