cloudflare 4.3.0 → 4.4.1

package/src/resources/dns-firewall/analytics/reports/bytimes.ts

@@ -38,7 +38,7 @@ export class Bytimes extends APIResource {
 
 export interface BytimeGetParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 

package/src/resources/dns-firewall/analytics/reports/reports.ts

@@ -42,7 +42,7 @@ export class Reports extends APIResource {
 
 export interface ReportGetParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 

package/src/resources/email-routing/email-routing.ts

@@ -46,13 +46,7 @@ export class EmailRouting extends APIResource {
    * Disable your Email Routing zone. Also removes additional MX records previously
    * required for Email Routing to work.
    *
-   * @example
-   * ```ts
-   * const settings = await client.emailRouting.disable({
-   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   body: {},
-   * });
-   * ```
+   * @deprecated
    */
   disable(params: EmailRoutingDisableParams, options?: Core.RequestOptions): Core.APIPromise<Settings> {
     const { zone_id, body } = params;
@@ -67,13 +61,7 @@ export class EmailRouting extends APIResource {
   /**
    * Enable you Email Routing zone. Add and lock the necessary MX and SPF records.
    *
-   * @example
-   * ```ts
-   * const settings = await client.emailRouting.enable({
-   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *   body: {},
-   * });
-   * ```
+   * @deprecated
    */
   enable(params: EmailRoutingEnableParams, options?: Core.RequestOptions): Core.APIPromise<Settings> {
     const { zone_id, body } = params;

package/src/resources/email-security/investigate/investigate.ts

@@ -113,6 +113,8 @@ export interface InvestigateListResponse {
    */
   postfix_id: string;
 
+  properties: InvestigateListResponse.Properties;
+
   ts: string;
 
   alert_id?: string | null;
@@ -166,6 +168,10 @@ export interface InvestigateListResponse {
 }
 
 export namespace InvestigateListResponse {
+  export interface Properties {
+    whitelisted_pattern_type?: string;
+  }
+
   export interface Validation {
     comment?: string | null;
 
@@ -195,6 +201,8 @@ export interface InvestigateGetResponse {
    */
   postfix_id: string;
 
+  properties: InvestigateGetResponse.Properties;
+
   ts: string;
 
   alert_id?: string | null;
@@ -248,6 +256,10 @@ export interface InvestigateGetResponse {
 }
 
 export namespace InvestigateGetResponse {
+  export interface Properties {
+    whitelisted_pattern_type?: string;
+  }
+
   export interface Validation {
     comment?: string | null;
 

package/src/resources/firewall/lockdowns.ts

@@ -269,6 +269,24 @@ export interface LockdownCreateParams {
    * use simple wildcard patterns.
    */
   urls: Array<OverridesAPI.OverrideURLParam>;
+
+  /**
+   * Body param: An informative summary of the rate limit. This value is sanitized
+   * and any tags will be removed.
+   */
+  description?: string;
+
+  /**
+   * Body param: When true, indicates that the rule is currently paused.
+   */
+  paused?: boolean;
+
+  /**
+   * Body param: The priority of the rule to control the processing order. A lower
+   * number indicates higher priority. If not provided, any rules with a configured
+   * priority will be processed before rules without a priority.
+   */
+  priority?: number;
 }
 
 export interface LockdownUpdateParams {

package/src/resources/firewall/ua-rules.ts

@@ -199,14 +199,9 @@ export interface UARuleCreateParams {
   zone_id: string;
 
   /**
-   * Body param: The rule configuration.
+   * Body param:
    */
-  configuration:
-    | AccessRulesAPI.AccessRuleIPConfigurationParam
-    | AccessRulesAPI.IPV6ConfigurationParam
-    | AccessRulesAPI.AccessRuleCIDRConfigurationParam
-    | AccessRulesAPI.ASNConfigurationParam
-    | AccessRulesAPI.CountryConfigurationParam;
+  configuration: UARuleCreateParams.Configuration;
 
   /**
    * Body param: The action to apply to a matched request.
@@ -214,6 +209,21 @@ export interface UARuleCreateParams {
   mode: 'block' | 'challenge' | 'whitelist' | 'js_challenge' | 'managed_challenge';
 }
 
+export namespace UARuleCreateParams {
+  export interface Configuration {
+    /**
+     * The configuration target. You must set the target to `ua` when specifying a user
+     * agent in the rule.
+     */
+    target?: 'ua';
+
+    /**
+     * the user agent to exactly match
+     */
+    value?: string;
+  }
+}
+
 export interface UARuleUpdateParams {
   /**
    * Path param: Defines an identifier.

package/src/resources/firewall/waf/overrides.ts

@@ -11,15 +11,7 @@ export class Overrides extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const override = await client.firewall.waf.overrides.create(
-   *   {
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     urls: ['shop.example.com/*'],
-   *   },
-   * );
-   * ```
+   * @deprecated
    */
   create(params: OverrideCreateParams, options?: Core.RequestOptions): Core.APIPromise<Override> {
     const { zone_id, ...body } = params;
@@ -36,19 +28,7 @@ export class Overrides extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const override = await client.firewall.waf.overrides.update(
-   *   'de677e5818985db1285d0e80225f06e5',
-   *   {
-   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     id: '023e105f4ecef8ad9ca31a8372d0c353',
-   *     rewrite_action: {},
-   *     rules: { '100015': 'disable' },
-   *     urls: ['shop.example.com/*'],
-   *   },
-   * );
-   * ```
+   * @deprecated
    */
   update(
     overridesId: string,
@@ -70,15 +50,7 @@ export class Overrides extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const override of client.firewall.waf.overrides.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     params: OverrideListParams,
@@ -98,13 +70,7 @@ export class Overrides extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const override = await client.firewall.waf.overrides.delete(
-   *   'de677e5818985db1285d0e80225f06e5',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated
    */
   delete(
     overridesId: string,
@@ -126,13 +92,7 @@ export class Overrides extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const override = await client.firewall.waf.overrides.get(
-   *   'de677e5818985db1285d0e80225f06e5',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated
    */
   get(
     overridesId: string,

package/src/resources/firewall/waf/packages/groups.ts

@@ -11,16 +11,7 @@ export class Groups extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const group of client.firewall.waf.packages.groups.list(
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     packageId: string,
@@ -42,15 +33,7 @@ export class Groups extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.firewall.waf.packages.groups.edit(
-   *     'a25a9a7e9c00afc1fb2e0245519d725b',
-   *     'a25a9a7e9c00afc1fb2e0245519d725b',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated
    */
   edit(
     packageId: string,
@@ -73,14 +56,7 @@ export class Groups extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const group = await client.firewall.waf.packages.groups.get(
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated
    */
   get(
     packageId: string,

package/src/resources/firewall/waf/packages/packages.ts

@@ -39,15 +39,7 @@ export class Packages extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const packageListResponse of client.firewall.waf.packages.list(
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     params: PackageListParams,
@@ -67,13 +59,7 @@ export class Packages extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const _package = await client.firewall.waf.packages.get(
-   *   '023e105f4ecef8ad9ca31a8372d0c353',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated
    */
   get(
     packageId: string,

package/src/resources/firewall/waf/packages/rules.ts

@@ -12,16 +12,7 @@ export class Rules extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const ruleListResponse of client.firewall.waf.packages.rules.list(
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * @deprecated
    */
   list(
     packageId: string,
@@ -42,15 +33,7 @@ export class Rules extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.firewall.waf.packages.rules.edit(
-   *     'a25a9a7e9c00afc1fb2e0245519d725b',
-   *     'a25a9a7e9c00afc1fb2e0245519d725b',
-   *     { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   *   );
-   * ```
+   * @deprecated
    */
   edit(
     packageId: string,
@@ -73,14 +56,7 @@ export class Rules extends APIResource {
    * **Note:** Applies only to the
    * [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
    *
-   * @example
-   * ```ts
-   * const rule = await client.firewall.waf.packages.rules.get(
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   'a25a9a7e9c00afc1fb2e0245519d725b',
-   *   { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
-   * );
-   * ```
+   * @deprecated
    */
   get(
     packageId: string,

package/src/resources/iam/iam.ts

@@ -25,18 +25,36 @@ import {
   ResourceGroupUpdateResponse,
   ResourceGroups,
 } from './resource-groups';
+import * as UserGroupsAPI from './user-groups/user-groups';
+import {
+  UserGroupCreateParams,
+  UserGroupCreateResponse,
+  UserGroupDeleteParams,
+  UserGroupDeleteResponse,
+  UserGroupGetParams,
+  UserGroupGetResponse,
+  UserGroupListParams,
+  UserGroupListResponse,
+  UserGroupListResponsesV4PagePaginationArray,
+  UserGroupUpdateParams,
+  UserGroupUpdateResponse,
+  UserGroups,
+} from './user-groups/user-groups';
 
 export class IAM extends APIResource {
   permissionGroups: PermissionGroupsAPI.PermissionGroups = new PermissionGroupsAPI.PermissionGroups(
     this._client,
   );
   resourceGroups: ResourceGroupsAPI.ResourceGroups = new ResourceGroupsAPI.ResourceGroups(this._client);
+  userGroups: UserGroupsAPI.UserGroups = new UserGroupsAPI.UserGroups(this._client);
 }
 
 IAM.PermissionGroups = PermissionGroups;
 IAM.PermissionGroupListResponsesV4PagePaginationArray = PermissionGroupListResponsesV4PagePaginationArray;
 IAM.ResourceGroups = ResourceGroups;
 IAM.ResourceGroupListResponsesV4PagePaginationArray = ResourceGroupListResponsesV4PagePaginationArray;
+IAM.UserGroups = UserGroups;
+IAM.UserGroupListResponsesV4PagePaginationArray = UserGroupListResponsesV4PagePaginationArray;
 
 export declare namespace IAM {
   export {
@@ -62,4 +80,19 @@ export declare namespace IAM {
     type ResourceGroupDeleteParams as ResourceGroupDeleteParams,
     type ResourceGroupGetParams as ResourceGroupGetParams,
   };
+
+  export {
+    UserGroups as UserGroups,
+    type UserGroupCreateResponse as UserGroupCreateResponse,
+    type UserGroupUpdateResponse as UserGroupUpdateResponse,
+    type UserGroupListResponse as UserGroupListResponse,
+    type UserGroupDeleteResponse as UserGroupDeleteResponse,
+    type UserGroupGetResponse as UserGroupGetResponse,
+    UserGroupListResponsesV4PagePaginationArray as UserGroupListResponsesV4PagePaginationArray,
+    type UserGroupCreateParams as UserGroupCreateParams,
+    type UserGroupUpdateParams as UserGroupUpdateParams,
+    type UserGroupListParams as UserGroupListParams,
+    type UserGroupDeleteParams as UserGroupDeleteParams,
+    type UserGroupGetParams as UserGroupGetParams,
+  };
 }

package/src/resources/iam/index.ts

@@ -23,3 +23,17 @@ export {
   type ResourceGroupDeleteParams,
   type ResourceGroupGetParams,
 } from './resource-groups';
+export {
+  UserGroupListResponsesV4PagePaginationArray,
+  UserGroups,
+  type UserGroupCreateResponse,
+  type UserGroupUpdateResponse,
+  type UserGroupListResponse,
+  type UserGroupDeleteResponse,
+  type UserGroupGetResponse,
+  type UserGroupCreateParams,
+  type UserGroupUpdateParams,
+  type UserGroupListParams,
+  type UserGroupDeleteParams,
+  type UserGroupGetParams,
+} from './user-groups/index';

package/src/resources/iam/permission-groups.ts

@@ -12,7 +12,7 @@ export class PermissionGroups extends APIResource {
    * ```ts
    * // Automatically fetches more pages as needed.
    * for await (const permissionGroupListResponse of client.iam.permissionGroups.list(
-   *   { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * )) {
    *   // ...
    * }
@@ -37,8 +37,8 @@ export class PermissionGroups extends APIResource {
    * ```ts
    * const permissionGroup =
    *   await client.iam.permissionGroups.get(
-   *     '6d7f2f5f5b1d4a0e9081fdc98d432fd1',
-   *     { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
    */
@@ -60,7 +60,7 @@ export class PermissionGroupListResponsesV4PagePaginationArray extends V4PagePag
  */
 export interface PermissionGroupListResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the permission group.
    */
   id: string;
 
@@ -70,7 +70,7 @@ export interface PermissionGroupListResponse {
   meta?: PermissionGroupListResponse.Meta;
 
   /**
-   * Name of the group.
+   * Name of the permission group.
    */
   name?: string;
 }
@@ -92,7 +92,7 @@ export namespace PermissionGroupListResponse {
  */
 export interface PermissionGroupGetResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the permission group.
    */
   id: string;
 
@@ -102,7 +102,7 @@ export interface PermissionGroupGetResponse {
   meta?: PermissionGroupGetResponse.Meta;
 
   /**
-   * Name of the group.
+   * Name of the permission group.
    */
   name?: string;
 }

package/src/resources/iam/resource-groups.ts

@@ -12,7 +12,7 @@ export class ResourceGroups extends APIResource {
    * ```ts
    * const resourceGroup =
    *   await client.iam.resourceGroups.create({
-   *     account_id: 'eb78d65290b24279ba6f44721b3ea3c4',
+   *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
    *     name: 'NewResourceGroup',
    *     scope: {
    *       key: 'com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4',
@@ -40,8 +40,8 @@ export class ResourceGroups extends APIResource {
    * ```ts
    * const resourceGroup =
    *   await client.iam.resourceGroups.update(
-   *     '6d7f2f5f5b1d4a0e9081fdc98d432fd1',
-   *     { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
    */
@@ -64,7 +64,7 @@ export class ResourceGroups extends APIResource {
    * ```ts
    * // Automatically fetches more pages as needed.
    * for await (const resourceGroupListResponse of client.iam.resourceGroups.list(
-   *   { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * )) {
    *   // ...
    * }
@@ -89,8 +89,8 @@ export class ResourceGroups extends APIResource {
    * ```ts
    * const resourceGroup =
    *   await client.iam.resourceGroups.delete(
-   *     '6d7f2f5f5b1d4a0e9081fdc98d432fd1',
-   *     { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *     '023e105f4ecef8ad9ca31a8372d0c353',
+   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    *   );
    * ```
    */
@@ -114,8 +114,8 @@ export class ResourceGroups extends APIResource {
    * @example
    * ```ts
    * const resourceGroup = await client.iam.resourceGroups.get(
-   *   '6d7f2f5f5b1d4a0e9081fdc98d432fd1',
-   *   { account_id: 'eb78d65290b24279ba6f44721b3ea3c4' },
+   *   '023e105f4ecef8ad9ca31a8372d0c353',
+   *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
    * );
    * ```
    */
@@ -189,7 +189,7 @@ export namespace ResourceGroupCreateResponse {
  */
 export interface ResourceGroupUpdateResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the resource group.
    */
   id: string;
 
@@ -255,7 +255,7 @@ export namespace ResourceGroupUpdateResponse {
  */
 export interface ResourceGroupListResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the resource group.
    */
   id: string;
 
@@ -328,7 +328,7 @@ export interface ResourceGroupDeleteResponse {
  */
 export interface ResourceGroupGetResponse {
   /**
-   * Identifier of the group.
+   * Identifier of the resource group.
    */
   id: string;
 

package/src/resources/iam/user-groups/index.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  MemberUpdateResponsesSinglePage,
+  MemberListResponsesV4PagePaginationArray,
+  Members,
+  type MemberCreateResponse,
+  type MemberUpdateResponse,
+  type MemberListResponse,
+  type MemberDeleteResponse,
+  type MemberCreateParams,
+  type MemberUpdateParams,
+  type MemberListParams,
+  type MemberDeleteParams,
+} from './members';
+export {
+  UserGroupListResponsesV4PagePaginationArray,
+  UserGroups,
+  type UserGroupCreateResponse,
+  type UserGroupUpdateResponse,
+  type UserGroupListResponse,
+  type UserGroupDeleteResponse,
+  type UserGroupGetResponse,
+  type UserGroupCreateParams,
+  type UserGroupUpdateParams,
+  type UserGroupListParams,
+  type UserGroupDeleteParams,
+  type UserGroupGetParams,
+} from './user-groups';