cloudflare 3.0.0-beta.1 → 3.0.0-beta.2

package/src/resources/alerting/v3/destinations/pagerduty.ts

@@ -71,6 +71,18 @@ export class Pagerduty extends APIResource {
   }
 }
 
+export interface AaaPagerduty {
+  /**
+   * UUID
+   */
+  id?: string;
+
+  /**
+   * The name of the pagerduty service.
+   */
+  name?: string;
+}
+
 export interface PagerdutyCreateResponse {
   /**
    * token in form of UUID
@@ -80,21 +92,7 @@ export interface PagerdutyCreateResponse {
 
 export type PagerdutyDeleteResponse = unknown | Array<unknown> | string;
 
-export type PagerdutyGetResponse = Array<PagerdutyGetResponse.PagerdutyGetResponseItem>;
-
-export namespace PagerdutyGetResponse {
-  export interface PagerdutyGetResponseItem {
-    /**
-     * UUID
-     */
-    id?: string;
-
-    /**
-     * The name of the pagerduty service.
-     */
-    name?: string;
-  }
-}
+export type PagerdutyGetResponse = Array<AaaPagerduty>;
 
 export interface PagerdutyLinkResponse {
   /**
@@ -132,6 +130,7 @@ export interface PagerdutyLinkParams {
 }
 
 export namespace Pagerduty {
+  export import AaaPagerduty = PagerdutyAPI.AaaPagerduty;
   export import PagerdutyCreateResponse = PagerdutyAPI.PagerdutyCreateResponse;
   export import PagerdutyDeleteResponse = PagerdutyAPI.PagerdutyDeleteResponse;
   export import PagerdutyGetResponse = PagerdutyAPI.PagerdutyGetResponse;

package/src/resources/alerting/v3/destinations/webhooks.ts

@@ -75,85 +75,18 @@ export class Webhooks extends APIResource {
     webhookId: string,
     params: WebhookGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<WebhookGetResponse> {
+  ): Core.APIPromise<AaaWebhooks> {
     const { account_id } = params;
     return (
       this._client.get(
         `/accounts/${account_id}/alerting/v3/destinations/webhooks/${webhookId}`,
         options,
-      ) as Core.APIPromise<{ result: WebhookGetResponse }>
+      ) as Core.APIPromise<{ result: AaaWebhooks }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface WebhookCreateResponse {
-  /**
-   * UUID
-   */
-  id?: string;
-}
-
-export interface WebhookUpdateResponse {
-  /**
-   * UUID
-   */
-  id?: string;
-}
-
-export type WebhookListResponse = Array<WebhookListResponse.WebhookListResponseItem>;
-
-export namespace WebhookListResponse {
-  export interface WebhookListResponseItem {
-    /**
-     * The unique identifier of a webhook
-     */
-    id?: string;
-
-    /**
-     * Timestamp of when the webhook destination was created.
-     */
-    created_at?: string;
-
-    /**
-     * Timestamp of the last time an attempt to dispatch a notification to this webhook
-     * failed.
-     */
-    last_failure?: string;
-
-    /**
-     * Timestamp of the last time Cloudflare was able to successfully dispatch a
-     * notification using this webhook.
-     */
-    last_success?: string;
-
-    /**
-     * The name of the webhook destination. This will be included in the request body
-     * when you receive a webhook notification.
-     */
-    name?: string;
-
-    /**
-     * Optional secret that will be passed in the `cf-webhook-auth` header when
-     * dispatching generic webhook notifications or formatted for supported
-     * destinations. Secrets are not returned in any API response body.
-     */
-    secret?: string;
-
-    /**
-     * Type of webhook endpoint.
-     */
-    type?: 'slack' | 'generic' | 'gchat';
-
-    /**
-     * The POST endpoint to call when dispatching a notification.
-     */
-    url?: string;
-  }
-}
-
-export type WebhookDeleteResponse = unknown | Array<unknown> | string;
-
-export interface WebhookGetResponse {
+export interface AaaWebhooks {
   /**
    * The unique identifier of a webhook
    */
@@ -200,6 +133,24 @@ export interface WebhookGetResponse {
   url?: string;
 }
 
+export interface WebhookCreateResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+}
+
+export interface WebhookUpdateResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+}
+
+export type WebhookListResponse = Array<AaaWebhooks>;
+
+export type WebhookDeleteResponse = unknown | Array<unknown> | string;
+
 export interface WebhookCreateParams {
   /**
    * Path param: The account id
@@ -272,11 +223,11 @@ export interface WebhookGetParams {
 }
 
 export namespace Webhooks {
+  export import AaaWebhooks = WebhooksAPI.AaaWebhooks;
   export import WebhookCreateResponse = WebhooksAPI.WebhookCreateResponse;
   export import WebhookUpdateResponse = WebhooksAPI.WebhookUpdateResponse;
   export import WebhookListResponse = WebhooksAPI.WebhookListResponse;
   export import WebhookDeleteResponse = WebhooksAPI.WebhookDeleteResponse;
-  export import WebhookGetResponse = WebhooksAPI.WebhookGetResponse;
   export import WebhookCreateParams = WebhooksAPI.WebhookCreateParams;
   export import WebhookUpdateParams = WebhooksAPI.WebhookUpdateParams;
   export import WebhookListParams = WebhooksAPI.WebhookListParams;

package/src/resources/alerting/v3/histories.ts

@@ -14,19 +14,19 @@ export class Histories extends APIResource {
   list(
     params: HistoryListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<HistoryListResponsesV4PagePaginationArray, HistoryListResponse> {
+  ): Core.PagePromise<AaaHistoriesV4PagePaginationArray, AaaHistory> {
     const { account_id, ...query } = params;
     return this._client.getAPIList(
       `/accounts/${account_id}/alerting/v3/history`,
-      HistoryListResponsesV4PagePaginationArray,
+      AaaHistoriesV4PagePaginationArray,
       { query, ...options },
     );
   }
 }
 
-export class HistoryListResponsesV4PagePaginationArray extends V4PagePaginationArray<HistoryListResponse> {}
+export class AaaHistoriesV4PagePaginationArray extends V4PagePaginationArray<AaaHistory> {}
 
-export interface HistoryListResponse {
+export interface AaaHistory {
   /**
    * UUID
    */
@@ -94,7 +94,7 @@ export interface HistoryListParams extends V4PagePaginationArrayParams {
 }
 
 export namespace Histories {
-  export import HistoryListResponse = HistoriesAPI.HistoryListResponse;
-  export import HistoryListResponsesV4PagePaginationArray = HistoriesAPI.HistoryListResponsesV4PagePaginationArray;
+  export import AaaHistory = HistoriesAPI.AaaHistory;
+  export import AaaHistoriesV4PagePaginationArray = HistoriesAPI.AaaHistoriesV4PagePaginationArray;
   export import HistoryListParams = HistoriesAPI.HistoryListParams;
 }

package/src/resources/alerting/v3/index.ts

@@ -1,18 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-export { Destinations } from './destinations/index';
-export {
-  HistoryListResponse,
-  HistoryListParams,
-  HistoryListResponsesV4PagePaginationArray,
-  Histories,
-} from './histories';
+export { AaaHistory, HistoryListParams, AaaHistoriesV4PagePaginationArray, Histories } from './histories';
 export {
+  AaaPolicies,
   PolicyCreateResponse,
   PolicyUpdateResponse,
   PolicyListResponse,
   PolicyDeleteResponse,
-  PolicyGetResponse,
   PolicyCreateParams,
   PolicyUpdateParams,
   PolicyListParams,
@@ -20,4 +14,5 @@ export {
   PolicyGetParams,
   Policies,
 } from './policies';
+export { Destinations } from './destinations/index';
 export { V3ListResponse, V3ListParams, V3 } from './v3';

package/src/resources/alerting/v3/policies.ts

@@ -71,361 +71,18 @@ export class Policies extends APIResource {
     policyId: string,
     params: PolicyGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<PolicyGetResponse> {
+  ): Core.APIPromise<AaaPolicies> {
     const { account_id } = params;
     return (
       this._client.get(
         `/accounts/${account_id}/alerting/v3/policies/${policyId}`,
         options,
-      ) as Core.APIPromise<{ result: PolicyGetResponse }>
+      ) as Core.APIPromise<{ result: AaaPolicies }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
-export interface PolicyCreateResponse {
-  /**
-   * UUID
-   */
-  id?: string;
-}
-
-export interface PolicyUpdateResponse {
-  /**
-   * UUID
-   */
-  id?: string;
-}
-
-export type PolicyListResponse = Array<PolicyListResponse.PolicyListResponseItem>;
-
-export namespace PolicyListResponse {
-  export interface PolicyListResponseItem {
-    /**
-     * The unique identifier of a notification policy
-     */
-    id?: string;
-
-    /**
-     * Refers to which event will trigger a Notification dispatch. You can use the
-     * endpoint to get available alert types which then will give you a list of
-     * possible values.
-     */
-    alert_type?:
-      | 'access_custom_certificate_expiration_type'
-      | 'advanced_ddos_attack_l4_alert'
-      | 'advanced_ddos_attack_l7_alert'
-      | 'advanced_http_alert_error'
-      | 'bgp_hijack_notification'
-      | 'billing_usage_alert'
-      | 'block_notification_block_removed'
-      | 'block_notification_new_block'
-      | 'block_notification_review_rejected'
-      | 'brand_protection_alert'
-      | 'brand_protection_digest'
-      | 'clickhouse_alert_fw_anomaly'
-      | 'clickhouse_alert_fw_ent_anomaly'
-      | 'custom_ssl_certificate_event_type'
-      | 'dedicated_ssl_certificate_event_type'
-      | 'dos_attack_l4'
-      | 'dos_attack_l7'
-      | 'expiring_service_token_alert'
-      | 'failing_logpush_job_disabled_alert'
-      | 'fbm_auto_advertisement'
-      | 'fbm_dosd_attack'
-      | 'fbm_volumetric_attack'
-      | 'health_check_status_notification'
-      | 'hostname_aop_custom_certificate_expiration_type'
-      | 'http_alert_edge_error'
-      | 'http_alert_origin_error'
-      | 'incident_alert'
-      | 'load_balancing_health_alert'
-      | 'load_balancing_pool_enablement_alert'
-      | 'logo_match_alert'
-      | 'magic_tunnel_health_check_event'
-      | 'maintenance_event_notification'
-      | 'mtls_certificate_store_certificate_expiration_type'
-      | 'pages_event_alert'
-      | 'radar_notification'
-      | 'real_origin_monitoring'
-      | 'scriptmonitor_alert_new_code_change_detections'
-      | 'scriptmonitor_alert_new_hosts'
-      | 'scriptmonitor_alert_new_malicious_hosts'
-      | 'scriptmonitor_alert_new_malicious_scripts'
-      | 'scriptmonitor_alert_new_malicious_url'
-      | 'scriptmonitor_alert_new_max_length_resource_url'
-      | 'scriptmonitor_alert_new_resources'
-      | 'secondary_dns_all_primaries_failing'
-      | 'secondary_dns_primaries_failing'
-      | 'secondary_dns_zone_successfully_updated'
-      | 'secondary_dns_zone_validation_warning'
-      | 'sentinel_alert'
-      | 'stream_live_notifications'
-      | 'traffic_anomalies_alert'
-      | 'tunnel_health_event'
-      | 'tunnel_update_event'
-      | 'universal_ssl_event_type'
-      | 'web_analytics_metrics_update'
-      | 'zone_aop_custom_certificate_expiration_type';
-
-    created?: string;
-
-    /**
-     * Optional description for the Notification policy.
-     */
-    description?: string;
-
-    /**
-     * Whether or not the Notification policy is enabled.
-     */
-    enabled?: boolean;
-
-    /**
-     * Optional filters that allow you to be alerted only on a subset of events for
-     * that alert type based on some criteria. This is only available for select alert
-     * types. See alert type documentation for more details.
-     */
-    filters?: PolicyListResponseItem.Filters;
-
-    /**
-     * List of IDs that will be used when dispatching a notification. IDs for email
-     * type will be the email address.
-     */
-    mechanisms?: Record<string, Array<PolicyListResponseItem.Mechanisms>>;
-
-    modified?: string;
-
-    /**
-     * Name of the policy.
-     */
-    name?: string;
-  }
-
-  export namespace PolicyListResponseItem {
-    /**
-     * Optional filters that allow you to be alerted only on a subset of events for
-     * that alert type based on some criteria. This is only available for select alert
-     * types. See alert type documentation for more details.
-     */
-    export interface Filters {
-      /**
-       * Usage depends on specific alert type
-       */
-      actions?: Array<string>;
-
-      /**
-       * Used for configuring radar_notification
-       */
-      affected_asns?: Array<string>;
-
-      /**
-       * Used for configuring incident_alert. A list of identifiers for each component to
-       * monitor.
-       */
-      affected_components?: Array<string>;
-
-      /**
-       * Used for configuring radar_notification
-       */
-      affected_locations?: Array<string>;
-
-      /**
-       * Used for configuring maintenance_event_notification
-       */
-      airport_code?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      alert_trigger_preferences?: Array<string>;
-
-      /**
-       * Used for configuring magic_tunnel_health_check_event
-       */
-      alert_trigger_preferences_value?: Array<'99.0' | '98.0' | '97.0'>;
-
-      /**
-       * Used for configuring load_balancing_pool_enablement_alert
-       */
-      enabled?: Array<string>;
-
-      /**
-       * Used for configuring pages_event_alert
-       */
-      environment?: Array<string>;
-
-      /**
-       * Used for configuring pages_event_alert
-       */
-      event?: Array<string>;
-
-      /**
-       * Used for configuring load_balancing_health_alert
-       */
-      event_source?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      event_type?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      group_by?: Array<string>;
-
-      /**
-       * Used for configuring health_check_status_notification
-       */
-      health_check_id?: Array<string>;
-
-      /**
-       * Used for configuring incident_alert
-       */
-      incident_impact?: Array<
-        | 'INCIDENT_IMPACT_NONE'
-        | 'INCIDENT_IMPACT_MINOR'
-        | 'INCIDENT_IMPACT_MAJOR'
-        | 'INCIDENT_IMPACT_CRITICAL'
-      >;
-
-      /**
-       * Used for configuring stream_live_notifications
-       */
-      input_id?: Array<string>;
-
-      /**
-       * Used for configuring billing_usage_alert
-       */
-      limit?: Array<string>;
-
-      /**
-       * Used for configuring logo_match_alert
-       */
-      logo_tag?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l4_alert
-       */
-      megabits_per_second?: Array<string>;
-
-      /**
-       * Used for configuring load_balancing_health_alert
-       */
-      new_health?: Array<string>;
-
-      /**
-       * Used for configuring tunnel_health_event
-       */
-      new_status?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l4_alert
-       */
-      packets_per_second?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      pool_id?: Array<string>;
-
-      /**
-       * Used for configuring billing_usage_alert
-       */
-      product?: Array<string>;
-
-      /**
-       * Used for configuring pages_event_alert
-       */
-      project_id?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l4_alert
-       */
-      protocol?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      query_tag?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l7_alert
-       */
-      requests_per_second?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      selectors?: Array<string>;
-
-      /**
-       * Used for configuring clickhouse_alert_fw_ent_anomaly
-       */
-      services?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      slo?: Array<string>;
-
-      /**
-       * Used for configuring health_check_status_notification
-       */
-      status?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l7_alert
-       */
-      target_hostname?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l4_alert
-       */
-      target_ip?: Array<string>;
-
-      /**
-       * Used for configuring advanced_ddos_attack_l7_alert
-       */
-      target_zone_name?: Array<string>;
-
-      /**
-       * Used for configuring traffic_anomalies_alert
-       */
-      traffic_exclusions?: Array<'security_events'>;
-
-      /**
-       * Used for configuring tunnel_health_event
-       */
-      tunnel_id?: Array<string>;
-
-      /**
-       * Used for configuring magic_tunnel_health_check_event
-       */
-      tunnel_name?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      where?: Array<string>;
-
-      /**
-       * Usage depends on specific alert type
-       */
-      zones?: Array<string>;
-    }
-
-    export interface Mechanisms {
-      /**
-       * UUID
-       */
-      id?: string | string;
-    }
-  }
-}
-
-export type PolicyDeleteResponse = unknown | Array<unknown> | string;
-
-export interface PolicyGetResponse {
+export interface AaaPolicies {
   /**
    * The unique identifier of a notification policy
    */
@@ -510,13 +167,13 @@ export interface PolicyGetResponse {
    * that alert type based on some criteria. This is only available for select alert
    * types. See alert type documentation for more details.
    */
-  filters?: PolicyGetResponse.Filters;
+  filters?: AaaPolicies.Filters;
 
   /**
    * List of IDs that will be used when dispatching a notification. IDs for email
    * type will be the email address.
    */
-  mechanisms?: Record<string, Array<PolicyGetResponse.Mechanisms>>;
+  mechanisms?: Record<string, Array<AaaPolicies.Mechanisms>>;
 
   modified?: string;
 
@@ -526,7 +183,7 @@ export interface PolicyGetResponse {
   name?: string;
 }
 
-export namespace PolicyGetResponse {
+export namespace AaaPolicies {
   /**
    * Optional filters that allow you to be alerted only on a subset of events for
    * that alert type based on some criteria. This is only available for select alert
@@ -745,6 +402,24 @@ export namespace PolicyGetResponse {
   }
 }
 
+export interface PolicyCreateResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+}
+
+export interface PolicyUpdateResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+}
+
+export type PolicyListResponse = Array<AaaPolicies>;
+
+export type PolicyDeleteResponse = unknown | Array<unknown> | string;
+
 export interface PolicyCreateParams {
   /**
    * Path param: The account id
@@ -1399,11 +1074,11 @@ export interface PolicyGetParams {
 }
 
 export namespace Policies {
+  export import AaaPolicies = PoliciesAPI.AaaPolicies;
   export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
   export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
   export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
   export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
-  export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
   export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
   export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
   export import PolicyListParams = PoliciesAPI.PolicyListParams;

package/src/resources/alerting/v3/v3.ts

@@ -39,15 +39,15 @@ export namespace V3 {
   export import V3ListParams = V3API.V3ListParams;
   export import Destinations = DestinationsAPI.Destinations;
   export import Histories = HistoriesAPI.Histories;
-  export import HistoryListResponse = HistoriesAPI.HistoryListResponse;
-  export import HistoryListResponsesV4PagePaginationArray = HistoriesAPI.HistoryListResponsesV4PagePaginationArray;
+  export import AaaHistory = HistoriesAPI.AaaHistory;
+  export import AaaHistoriesV4PagePaginationArray = HistoriesAPI.AaaHistoriesV4PagePaginationArray;
   export import HistoryListParams = HistoriesAPI.HistoryListParams;
   export import Policies = PoliciesAPI.Policies;
+  export import AaaPolicies = PoliciesAPI.AaaPolicies;
   export import PolicyCreateResponse = PoliciesAPI.PolicyCreateResponse;
   export import PolicyUpdateResponse = PoliciesAPI.PolicyUpdateResponse;
   export import PolicyListResponse = PoliciesAPI.PolicyListResponse;
   export import PolicyDeleteResponse = PoliciesAPI.PolicyDeleteResponse;
-  export import PolicyGetResponse = PoliciesAPI.PolicyGetResponse;
   export import PolicyCreateParams = PoliciesAPI.PolicyCreateParams;
   export import PolicyUpdateParams = PoliciesAPI.PolicyUpdateParams;
   export import PolicyListParams = PoliciesAPI.PolicyListParams;

package/src/resources/challenges/challenges.ts

@@ -9,4 +9,13 @@ export class Challenges extends APIResource {
 
 export namespace Challenges {
   export import Widgets = WidgetsAPI.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;
 }