cloudflare 5.2.0 → 6.0.0-beta.1

package/src/resources/alerting/alerting.ts

@@ -21,6 +21,22 @@ import {
   PolicyUpdateParams,
   PolicyUpdateResponse,
 } from './policies';
+import * as SilencesAPI from './silences';
+import {
+  SilenceCreateParams,
+  SilenceCreateResponse,
+  SilenceDeleteParams,
+  SilenceDeleteResponse,
+  SilenceGetParams,
+  SilenceGetResponse,
+  SilenceListParams,
+  SilenceListResponse,
+  SilenceListResponsesSinglePage,
+  SilenceUpdateParams,
+  SilenceUpdateResponse,
+  SilenceUpdateResponsesSinglePage,
+  Silences,
+} from './silences';
 import * as DestinationsAPI from './destinations/destinations';
 import { Destinations } from './destinations/destinations';
 
@@ -29,6 +45,7 @@ export class Alerting extends APIResource {
   destinations: DestinationsAPI.Destinations = new DestinationsAPI.Destinations(this._client);
   history: HistoryAPI.HistoryResource = new HistoryAPI.HistoryResource(this._client);
   policies: PoliciesAPI.Policies = new PoliciesAPI.Policies(this._client);
+  silences: SilencesAPI.Silences = new SilencesAPI.Silences(this._client);
 }
 
 Alerting.AvailableAlerts = AvailableAlerts;
@@ -37,6 +54,9 @@ Alerting.HistoryResource = HistoryResource;
 Alerting.HistoriesV4PagePaginationArray = HistoriesV4PagePaginationArray;
 Alerting.Policies = Policies;
 Alerting.PoliciesSinglePage = PoliciesSinglePage;
+Alerting.Silences = Silences;
+Alerting.SilenceUpdateResponsesSinglePage = SilenceUpdateResponsesSinglePage;
+Alerting.SilenceListResponsesSinglePage = SilenceListResponsesSinglePage;
 
 export declare namespace Alerting {
   export {
@@ -69,4 +89,20 @@ export declare namespace Alerting {
     type PolicyDeleteParams as PolicyDeleteParams,
     type PolicyGetParams as PolicyGetParams,
   };
+
+  export {
+    Silences as Silences,
+    type SilenceCreateResponse as SilenceCreateResponse,
+    type SilenceUpdateResponse as SilenceUpdateResponse,
+    type SilenceListResponse as SilenceListResponse,
+    type SilenceDeleteResponse as SilenceDeleteResponse,
+    type SilenceGetResponse as SilenceGetResponse,
+    SilenceUpdateResponsesSinglePage as SilenceUpdateResponsesSinglePage,
+    SilenceListResponsesSinglePage as SilenceListResponsesSinglePage,
+    type SilenceCreateParams as SilenceCreateParams,
+    type SilenceUpdateParams as SilenceUpdateParams,
+    type SilenceListParams as SilenceListParams,
+    type SilenceDeleteParams as SilenceDeleteParams,
+    type SilenceGetParams as SilenceGetParams,
+  };
 }

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

@@ -35,7 +35,7 @@ export class Webhooks extends APIResource {
    * ```ts
    * const webhook =
    *   await client.alerting.destinations.webhooks.update(
-   *     'b115d5ec-15c6-41ee-8b76-92c449b5227b',
+   *     'b115d5ec15c641ee8b7692c449b5227b',
    *     {
    *       account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *       name: 'Slack Webhook',
@@ -90,7 +90,7 @@ export class Webhooks extends APIResource {
    * ```ts
    * const webhook =
    *   await client.alerting.destinations.webhooks.delete(
-   *     'b115d5ec-15c6-41ee-8b76-92c449b5227b',
+   *     'b115d5ec15c641ee8b7692c449b5227b',
    *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
@@ -114,7 +114,7 @@ export class Webhooks extends APIResource {
    * ```ts
    * const webhooks =
    *   await client.alerting.destinations.webhooks.get(
-   *     'b115d5ec-15c6-41ee-8b76-92c449b5227b',
+   *     'b115d5ec15c641ee8b7692c449b5227b',
    *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```

package/src/resources/alerting/index.ts

@@ -28,3 +28,18 @@ export {
   type PolicyDeleteParams,
   type PolicyGetParams,
 } from './policies';
+export {
+  SilenceUpdateResponsesSinglePage,
+  SilenceListResponsesSinglePage,
+  Silences,
+  type SilenceCreateResponse,
+  type SilenceUpdateResponse,
+  type SilenceListResponse,
+  type SilenceDeleteResponse,
+  type SilenceGetResponse,
+  type SilenceCreateParams,
+  type SilenceUpdateParams,
+  type SilenceListParams,
+  type SilenceDeleteParams,
+  type SilenceGetParams,
+} from './silences';

package/src/resources/alerting/policies.ts

@@ -35,7 +35,7 @@ export class Policies extends APIResource {
    * @example
    * ```ts
    * const policy = await client.alerting.policies.update(
-   *   '0da2b59e-f118-439d-8097-bdfb215203c9',
+   *   '0da2b59ef118439d8097bdfb215203c9',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -85,7 +85,7 @@ export class Policies extends APIResource {
    * @example
    * ```ts
    * const policy = await client.alerting.policies.delete(
-   *   '0da2b59e-f118-439d-8097-bdfb215203c9',
+   *   '0da2b59ef118439d8097bdfb215203c9',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -105,7 +105,7 @@ export class Policies extends APIResource {
    * @example
    * ```ts
    * const policy = await client.alerting.policies.get(
-   *   '0da2b59e-f118-439d-8097-bdfb215203c9',
+   *   '0da2b59ef118439d8097bdfb215203c9',
    *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
@@ -211,6 +211,7 @@ export interface Policy {
    * possible values.
    */
   alert_type?:
+    | 'abuse_report_alert'
     | 'access_custom_certificate_expiration_type'
     | 'advanced_ddos_attack_l4_alert'
     | 'advanced_ddos_attack_l7_alert'
@@ -520,6 +521,11 @@ export interface PolicyFilter {
    */
   tunnel_name?: Array<string>;
 
+  /**
+   * Usage depends on specific alert type
+   */
+  type?: Array<string>;
+
   /**
    * Usage depends on specific alert type
    */
@@ -739,6 +745,11 @@ export interface PolicyFilterParam {
    */
   tunnel_name?: Array<string>;
 
+  /**
+   * Usage depends on specific alert type
+   */
+  type?: Array<string>;
+
   /**
    * Usage depends on specific alert type
    */
@@ -825,6 +836,7 @@ export interface PolicyCreateParams {
    * possible values.
    */
   alert_type:
+    | 'abuse_report_alert'
     | 'access_custom_certificate_expiration_type'
     | 'advanced_ddos_attack_l4_alert'
     | 'advanced_ddos_attack_l7_alert'
@@ -946,6 +958,7 @@ export interface PolicyUpdateParams {
    * possible values.
    */
   alert_type?:
+    | 'abuse_report_alert'
     | 'access_custom_certificate_expiration_type'
     | 'advanced_ddos_attack_l4_alert'
     | 'advanced_ddos_attack_l7_alert'

package/src/resources/alerting/silences.ts

@@ -0,0 +1,374 @@
+// 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 Silences extends APIResource {
+  /**
+   * Creates a new silence for an account.
+   *
+   * @example
+   * ```ts
+   * const silence = await client.alerting.silences.create({
+   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   body: [{}],
+   * });
+   * ```
+   */
+  create(params: SilenceCreateParams, options?: Core.RequestOptions): Core.APIPromise<SilenceCreateResponse> {
+    const { account_id, body } = params;
+    return this._client.post(`/accounts/${account_id}/alerting/v3/silences`, { body: body, ...options });
+  }
+
+  /**
+   * Updates existing silences for an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const silenceUpdateResponse of client.alerting.silences.update(
+   *   {
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *     body: [{}],
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  update(
+    params: SilenceUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SilenceUpdateResponsesSinglePage, SilenceUpdateResponse> {
+    const { account_id, body } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/alerting/v3/silences`,
+      SilenceUpdateResponsesSinglePage,
+      { body: body, method: 'put', ...options },
+    );
+  }
+
+  /**
+   * Gets a list of silences for an account.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const silenceListResponse of client.alerting.silences.list(
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params: SilenceListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SilenceListResponsesSinglePage, SilenceListResponse> {
+    const { account_id } = params;
+    return this._client.getAPIList(
+      `/accounts/${account_id}/alerting/v3/silences`,
+      SilenceListResponsesSinglePage,
+      options,
+    );
+  }
+
+  /**
+   * Deletes an existing silence for an account.
+   *
+   * @example
+   * ```ts
+   * const silence = await client.alerting.silences.delete(
+   *   'f878e90c23f44126ae3cfc399f646977',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
+   */
+  delete(
+    silenceId: string,
+    params: SilenceDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SilenceDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(`/accounts/${account_id}/alerting/v3/silences/${silenceId}`, options);
+  }
+
+  /**
+   * Gets a specific silence for an account.
+   *
+   * @example
+   * ```ts
+   * const silence = await client.alerting.silences.get(
+   *   'f878e90c23f44126ae3cfc399f646977',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
+   * );
+   * ```
+   */
+  get(
+    silenceId: string,
+    params: SilenceGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SilenceGetResponse> {
+    const { account_id } = params;
+    return (
+      this._client.get(
+        `/accounts/${account_id}/alerting/v3/silences/${silenceId}`,
+        options,
+      ) as Core.APIPromise<{ result: SilenceGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class SilenceUpdateResponsesSinglePage extends SinglePage<SilenceUpdateResponse> {}
+
+export class SilenceListResponsesSinglePage extends SinglePage<SilenceListResponse> {}
+
+export interface SilenceCreateResponse {
+  errors: Array<SilenceCreateResponse.Error>;
+
+  messages: Array<SilenceCreateResponse.Message>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
+
+export namespace SilenceCreateResponse {
+  export interface Error {
+    message: string;
+
+    code?: number;
+  }
+
+  export interface Message {
+    message: string;
+
+    code?: number;
+  }
+}
+
+export interface SilenceUpdateResponse {
+  /**
+   * Silence ID
+   */
+  id?: string;
+
+  /**
+   * When the silence was created.
+   */
+  created_at?: string;
+
+  /**
+   * When the silence ends.
+   */
+  end_time?: string;
+
+  /**
+   * The unique identifier of a notification policy
+   */
+  policy_id?: string;
+
+  /**
+   * When the silence starts.
+   */
+  start_time?: string;
+
+  /**
+   * When the silence was modified.
+   */
+  updated_at?: string;
+}
+
+export interface SilenceListResponse {
+  /**
+   * Silence ID
+   */
+  id?: string;
+
+  /**
+   * When the silence was created.
+   */
+  created_at?: string;
+
+  /**
+   * When the silence ends.
+   */
+  end_time?: string;
+
+  /**
+   * The unique identifier of a notification policy
+   */
+  policy_id?: string;
+
+  /**
+   * When the silence starts.
+   */
+  start_time?: string;
+
+  /**
+   * When the silence was modified.
+   */
+  updated_at?: string;
+}
+
+export interface SilenceDeleteResponse {
+  errors: Array<SilenceDeleteResponse.Error>;
+
+  messages: Array<SilenceDeleteResponse.Message>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
+
+export namespace SilenceDeleteResponse {
+  export interface Error {
+    message: string;
+
+    code?: number;
+  }
+
+  export interface Message {
+    message: string;
+
+    code?: number;
+  }
+}
+
+export interface SilenceGetResponse {
+  /**
+   * Silence ID
+   */
+  id?: string;
+
+  /**
+   * When the silence was created.
+   */
+  created_at?: string;
+
+  /**
+   * When the silence ends.
+   */
+  end_time?: string;
+
+  /**
+   * The unique identifier of a notification policy
+   */
+  policy_id?: string;
+
+  /**
+   * When the silence starts.
+   */
+  start_time?: string;
+
+  /**
+   * When the silence was modified.
+   */
+  updated_at?: string;
+}
+
+export interface SilenceCreateParams {
+  /**
+   * Path param: The account id
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  body: Array<SilenceCreateParams.Body>;
+}
+
+export namespace SilenceCreateParams {
+  export interface Body {
+    /**
+     * When the silence ends.
+     */
+    end_time?: string;
+
+    /**
+     * The unique identifier of a notification policy
+     */
+    policy_id?: string;
+
+    /**
+     * When the silence starts.
+     */
+    start_time?: string;
+  }
+}
+
+export interface SilenceUpdateParams {
+  /**
+   * Path param: The account id
+   */
+  account_id: string;
+
+  /**
+   * Body param:
+   */
+  body: Array<SilenceUpdateParams.Body>;
+}
+
+export namespace SilenceUpdateParams {
+  export interface Body {
+    /**
+     * Silence ID
+     */
+    id?: string;
+
+    /**
+     * When the silence ends.
+     */
+    end_time?: string;
+
+    /**
+     * When the silence starts.
+     */
+    start_time?: string;
+  }
+}
+
+export interface SilenceListParams {
+  /**
+   * The account id
+   */
+  account_id: string;
+}
+
+export interface SilenceDeleteParams {
+  /**
+   * The account id
+   */
+  account_id: string;
+}
+
+export interface SilenceGetParams {
+  /**
+   * The account id
+   */
+  account_id: string;
+}
+
+Silences.SilenceUpdateResponsesSinglePage = SilenceUpdateResponsesSinglePage;
+Silences.SilenceListResponsesSinglePage = SilenceListResponsesSinglePage;
+
+export declare namespace Silences {
+  export {
+    type SilenceCreateResponse as SilenceCreateResponse,
+    type SilenceUpdateResponse as SilenceUpdateResponse,
+    type SilenceListResponse as SilenceListResponse,
+    type SilenceDeleteResponse as SilenceDeleteResponse,
+    type SilenceGetResponse as SilenceGetResponse,
+    SilenceUpdateResponsesSinglePage as SilenceUpdateResponsesSinglePage,
+    SilenceListResponsesSinglePage as SilenceListResponsesSinglePage,
+    type SilenceCreateParams as SilenceCreateParams,
+    type SilenceUpdateParams as SilenceUpdateParams,
+    type SilenceListParams as SilenceListParams,
+    type SilenceDeleteParams as SilenceDeleteParams,
+    type SilenceGetParams as SilenceGetParams,
+  };
+}

package/src/resources/api-gateway/api-gateway.ts

@@ -6,7 +6,6 @@ import {
   Configuration,
   ConfigurationGetParams,
   ConfigurationUpdateParams,
-  ConfigurationUpdateResponse,
   Configurations,
 } from './configurations';
 import * as SchemasAPI from './schemas';
@@ -44,10 +43,10 @@ import { Settings } from './settings/settings';
 import * as UserSchemasAPI from './user-schemas/user-schemas';
 import {
   Message,
-  PublicSchema,
-  PublicSchemasV4PagePaginationArray,
-  SchemaUpload,
+  OldPublicSchema,
+  OldPublicSchemasV4PagePaginationArray,
   UserSchemaCreateParams,
+  UserSchemaCreateResponse,
   UserSchemaDeleteParams,
   UserSchemaDeleteResponse,
   UserSchemaEditParams,
@@ -75,14 +74,13 @@ APIGateway.OperationListResponsesV4PagePaginationArray = OperationListResponsesV
 APIGateway.OperationBulkCreateResponsesSinglePage = OperationBulkCreateResponsesSinglePage;
 APIGateway.Schemas = Schemas;
 APIGateway.UserSchemas = UserSchemas;
-APIGateway.PublicSchemasV4PagePaginationArray = PublicSchemasV4PagePaginationArray;
+APIGateway.OldPublicSchemasV4PagePaginationArray = OldPublicSchemasV4PagePaginationArray;
 APIGateway.ExpressionTemplate = ExpressionTemplate;
 
 export declare namespace APIGateway {
   export {
     Configurations as Configurations,
     type Configuration as Configuration,
-    type ConfigurationUpdateResponse as ConfigurationUpdateResponse,
     type ConfigurationUpdateParams as ConfigurationUpdateParams,
     type ConfigurationGetParams as ConfigurationGetParams,
   };
@@ -124,10 +122,10 @@ export declare namespace APIGateway {
   export {
     UserSchemas as UserSchemas,
     type Message as Message,
-    type PublicSchema as PublicSchema,
-    type SchemaUpload as SchemaUpload,
+    type OldPublicSchema as OldPublicSchema,
+    type UserSchemaCreateResponse as UserSchemaCreateResponse,
     type UserSchemaDeleteResponse as UserSchemaDeleteResponse,
-    PublicSchemasV4PagePaginationArray as PublicSchemasV4PagePaginationArray,
+    OldPublicSchemasV4PagePaginationArray as OldPublicSchemasV4PagePaginationArray,
     type UserSchemaCreateParams as UserSchemaCreateParams,
     type UserSchemaListParams as UserSchemaListParams,
     type UserSchemaDeleteParams as UserSchemaDeleteParams,

package/src/resources/api-gateway/configurations.ts

@@ -2,11 +2,10 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
-import * as UserSchemasAPI from './user-schemas/user-schemas';
 
 export class Configurations extends APIResource {
   /**
-   * Set configuration properties
+   * Update configuration properties
    *
    * @example
    * ```ts
@@ -19,12 +18,15 @@ export class Configurations extends APIResource {
    *   });
    * ```
    */
-  update(
-    params: ConfigurationUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ConfigurationUpdateResponse> {
-    const { zone_id, ...body } = params;
-    return this._client.put(`/zones/${zone_id}/api_gateway/configuration`, { body, ...options });
+  update(params: ConfigurationUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Configuration> {
+    const { zone_id, normalize, ...body } = params;
+    return (
+      this._client.put(`/zones/${zone_id}/api_gateway/configuration`, {
+        query: { normalize },
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Configuration }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -93,17 +95,6 @@ export namespace Configuration {
   }
 }
 
-export interface ConfigurationUpdateResponse {
-  errors: UserSchemasAPI.Message;
-
-  messages: UserSchemasAPI.Message;
-
-  /**
-   * Whether the API call was successful.
-   */
-  success: true;
-}
-
 export interface ConfigurationUpdateParams {
   /**
    * Path param: Identifier.
@@ -117,6 +108,12 @@ export interface ConfigurationUpdateParams {
     | ConfigurationUpdateParams.APIShieldAuthIDCharacteristic
     | ConfigurationUpdateParams.APIShieldAuthIDCharacteristicJWTClaim
   >;
+
+  /**
+   * Query param: Ensures that the configuration is written or retrieved in
+   * normalized fashion
+   */
+  normalize?: boolean;
 }
 
 export namespace ConfigurationUpdateParams {
@@ -164,15 +161,15 @@ export interface ConfigurationGetParams {
   zone_id: string;
 
   /**
-   * Query param: Requests information about certain properties.
+   * Query param: Ensures that the configuration is written or retrieved in
+   * normalized fashion
    */
-  properties?: Array<'auth_id_characteristics'>;
+  normalize?: boolean;
 }
 
 export declare namespace Configurations {
   export {
     type Configuration as Configuration,
-    type ConfigurationUpdateResponse as ConfigurationUpdateResponse,
     type ConfigurationUpdateParams as ConfigurationUpdateParams,
     type ConfigurationGetParams as ConfigurationGetParams,
   };