cloudflare 4.0.0 → 4.1.0

package/src/resources/zero-trust/access/groups.ts

@@ -3,15 +3,15 @@
 import { APIResource } from '../../../resource';
 import { isRequestOptions } from '../../../core';
 import * as Core from '../../../core';
-import { CloudflareError } from "../../../error";
-import * as AccessAPI from './access';
+import * as PoliciesAPI from './applications/policies';
+import { CloudflareError } from '../../../error';
 import { SinglePage } from '../../../pagination';
 
 export class Groups extends APIResource {
   /**
    * Creates a new Access group.
    */
-  create(params: GroupCreateParams, options?: Core.RequestOptions): Core.APIPromise<ZeroTrustGroup> {
+  create(params: GroupCreateParams, options?: Core.RequestOptions): Core.APIPromise<GroupCreateResponse> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -33,7 +33,7 @@ export class Groups extends APIResource {
       this._client.post(`/${accountOrZone}/${accountOrZoneId}/access/groups`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: ZeroTrustGroup }>
+      }) as Core.APIPromise<{ result: GroupCreateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -44,7 +44,7 @@ export class Groups extends APIResource {
     groupId: string,
     params: GroupUpdateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ZeroTrustGroup> {
+  ): Core.APIPromise<GroupUpdateResponse> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -66,7 +66,7 @@ export class Groups extends APIResource {
       this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/groups/${groupId}`, {
         body,
         ...options,
-      }) as Core.APIPromise<{ result: ZeroTrustGroup }>
+      }) as Core.APIPromise<{ result: GroupUpdateResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 
@@ -76,12 +76,12 @@ export class Groups extends APIResource {
   list(
     params?: GroupListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ZeroTrustGroupsSinglePage, ZeroTrustGroup>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ZeroTrustGroupsSinglePage, ZeroTrustGroup>;
+  ): Core.PagePromise<GroupListResponsesSinglePage, GroupListResponse>;
+  list(options?: Core.RequestOptions): Core.PagePromise<GroupListResponsesSinglePage, GroupListResponse>;
   list(
     params: GroupListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<ZeroTrustGroupsSinglePage, ZeroTrustGroup> {
+  ): Core.PagePromise<GroupListResponsesSinglePage, GroupListResponse> {
     if (isRequestOptions(params)) {
       return this.list({}, params);
     }
@@ -104,7 +104,7 @@ export class Groups extends APIResource {
         };
     return this._client.getAPIList(
       `/${accountOrZone}/${accountOrZoneId}/access/groups`,
-      ZeroTrustGroupsSinglePage,
+      GroupListResponsesSinglePage,
       { query, ...options },
     );
   }
@@ -158,13 +158,13 @@ export class Groups extends APIResource {
     groupId: string,
     params?: GroupGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ZeroTrustGroup>;
-  get(groupId: string, options?: Core.RequestOptions): Core.APIPromise<ZeroTrustGroup>;
+  ): Core.APIPromise<GroupGetResponse>;
+  get(groupId: string, options?: Core.RequestOptions): Core.APIPromise<GroupGetResponse>;
   get(
     groupId: string,
     params: GroupGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<ZeroTrustGroup> {
+  ): Core.APIPromise<GroupGetResponse> {
     if (isRequestOptions(params)) {
       return this.get(groupId, {}, params);
     }
@@ -189,14 +189,60 @@ export class Groups extends APIResource {
       this._client.get(
         `/${accountOrZone}/${accountOrZoneId}/access/groups/${groupId}`,
         options,
-      ) as Core.APIPromise<{ result: ZeroTrustGroup }>
+      ) as Core.APIPromise<{ result: GroupGetResponse }>
     )._thenUnwrap((obj) => obj.result);
   }
 }
 
+export class GroupListResponsesSinglePage extends SinglePage<GroupListResponse> {}
+
 export class ZeroTrustGroupsSinglePage extends SinglePage<ZeroTrustGroup> {}
 
 export interface ZeroTrustGroup {
+  /**
+   * The unique Cloudflare-generated Id of the SCIM resource.
+   */
+  id?: string;
+
+  /**
+   * The display name of the SCIM Group resource.
+   */
+  displayName?: string;
+
+  /**
+   * The IdP-generated Id of the SCIM resource.
+   */
+  externalId?: string;
+
+  /**
+   * The metadata of the SCIM resource.
+   */
+  meta?: ZeroTrustGroup.Meta;
+
+  /**
+   * The list of URIs which indicate the attributes contained within a SCIM resource.
+   */
+  schemas?: Array<string>;
+}
+
+export namespace ZeroTrustGroup {
+  /**
+   * The metadata of the SCIM resource.
+   */
+  export interface Meta {
+    /**
+     * The timestamp of when the SCIM resource was created.
+     */
+    created?: string;
+
+    /**
+     * The timestamp of when the SCIM resource was last modified.
+     */
+    lastModified?: string;
+  }
+}
+
+export interface GroupCreateResponse {
   /**
    * UUID
    */
@@ -208,19 +254,19 @@ export interface ZeroTrustGroup {
    * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
    * meet any of the Exclude rules.
    */
-  exclude?: Array<AccessAPI.AccessRule>;
+  exclude?: Array<PoliciesAPI.AccessRule>;
 
   /**
    * Rules evaluated with an OR logical operator. A user needs to meet only one of
    * the Include rules.
    */
-  include?: Array<AccessAPI.AccessRule>;
+  include?: Array<PoliciesAPI.AccessRule>;
 
   /**
    * Rules evaluated with an AND logical operator. To match a policy, a user must
    * meet all of the Require rules.
    */
-  is_default?: Array<AccessAPI.AccessRule>;
+  is_default?: Array<PoliciesAPI.AccessRule>;
 
   /**
    * The name of the Access group.
@@ -231,7 +277,87 @@ export interface ZeroTrustGroup {
    * Rules evaluated with an AND logical operator. To match a policy, a user must
    * meet all of the Require rules.
    */
-  require?: Array<AccessAPI.AccessRule>;
+  require?: Array<PoliciesAPI.AccessRule>;
+
+  updated_at?: string;
+}
+
+export interface GroupUpdateResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+
+  created_at?: string;
+
+  /**
+   * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
+   * meet any of the Exclude rules.
+   */
+  exclude?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an OR logical operator. A user needs to meet only one of
+   * the Include rules.
+   */
+  include?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  is_default?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * The name of the Access group.
+   */
+  name?: string;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  require?: Array<PoliciesAPI.AccessRule>;
+
+  updated_at?: string;
+}
+
+export interface GroupListResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+
+  created_at?: string;
+
+  /**
+   * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
+   * meet any of the Exclude rules.
+   */
+  exclude?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an OR logical operator. A user needs to meet only one of
+   * the Include rules.
+   */
+  include?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  is_default?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * The name of the Access group.
+   */
+  name?: string;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  require?: Array<PoliciesAPI.AccessRule>;
 
   updated_at?: string;
 }
@@ -243,12 +369,52 @@ export interface GroupDeleteResponse {
   id?: string;
 }
 
+export interface GroupGetResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+
+  created_at?: string;
+
+  /**
+   * Rules evaluated with a NOT logical operator. To match a policy, a user cannot
+   * meet any of the Exclude rules.
+   */
+  exclude?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an OR logical operator. A user needs to meet only one of
+   * the Include rules.
+   */
+  include?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  is_default?: Array<PoliciesAPI.AccessRule>;
+
+  /**
+   * The name of the Access group.
+   */
+  name?: string;
+
+  /**
+   * Rules evaluated with an AND logical operator. To match a policy, a user must
+   * meet all of the Require rules.
+   */
+  require?: Array<PoliciesAPI.AccessRule>;
+
+  updated_at?: string;
+}
+
 export interface GroupCreateParams {
   /**
    * Body param: Rules evaluated with an OR logical operator. A user needs to meet
    * only one of the Include rules.
    */
-  include: Array<AccessAPI.AccessRuleParam>;
+  include: Array<PoliciesAPI.AccessRuleParam>;
 
   /**
    * Body param: The name of the Access group.
@@ -271,7 +437,7 @@ export interface GroupCreateParams {
    * Body param: Rules evaluated with a NOT logical operator. To match a policy, a
    * user cannot meet any of the Exclude rules.
    */
-  exclude?: Array<AccessAPI.AccessRuleParam>;
+  exclude?: Array<PoliciesAPI.AccessRuleParam>;
 
   /**
    * Body param: Whether this is the default group
@@ -282,7 +448,7 @@ export interface GroupCreateParams {
    * Body param: Rules evaluated with an AND logical operator. To match a policy, a
    * user must meet all of the Require rules.
    */
-  require?: Array<AccessAPI.AccessRuleParam>;
+  require?: Array<PoliciesAPI.AccessRuleParam>;
 }
 
 export interface GroupUpdateParams {
@@ -290,7 +456,7 @@ export interface GroupUpdateParams {
    * Body param: Rules evaluated with an OR logical operator. A user needs to meet
    * only one of the Include rules.
    */
-  include: Array<AccessAPI.AccessRuleParam>;
+  include: Array<PoliciesAPI.AccessRuleParam>;
 
   /**
    * Body param: The name of the Access group.
@@ -313,7 +479,7 @@ export interface GroupUpdateParams {
    * Body param: Rules evaluated with a NOT logical operator. To match a policy, a
    * user cannot meet any of the Exclude rules.
    */
-  exclude?: Array<AccessAPI.AccessRuleParam>;
+  exclude?: Array<PoliciesAPI.AccessRuleParam>;
 
   /**
    * Body param: Whether this is the default group
@@ -324,7 +490,7 @@ export interface GroupUpdateParams {
    * Body param: Rules evaluated with an AND logical operator. To match a policy, a
    * user must meet all of the Require rules.
    */
-  require?: Array<AccessAPI.AccessRuleParam>;
+  require?: Array<PoliciesAPI.AccessRuleParam>;
 }
 
 export interface GroupListParams {
@@ -375,13 +541,17 @@ export interface GroupGetParams {
   zone_id?: string;
 }
 
-Groups.ZeroTrustGroupsSinglePage = ZeroTrustGroupsSinglePage;
+Groups.GroupListResponsesSinglePage = GroupListResponsesSinglePage;
 
 export declare namespace Groups {
   export {
     type ZeroTrustGroup as ZeroTrustGroup,
+    type GroupCreateResponse as GroupCreateResponse,
+    type GroupUpdateResponse as GroupUpdateResponse,
+    type GroupListResponse as GroupListResponse,
     type GroupDeleteResponse as GroupDeleteResponse,
-    ZeroTrustGroupsSinglePage as ZeroTrustGroupsSinglePage,
+    type GroupGetResponse as GroupGetResponse,
+    GroupListResponsesSinglePage as GroupListResponsesSinglePage,
     type GroupCreateParams as GroupCreateParams,
     type GroupUpdateParams as GroupUpdateParams,
     type GroupListParams as GroupListParams,

package/src/resources/zero-trust/access/index.ts

@@ -1,29 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Access } from './access';
 export {
-  Access,
-  type AccessDevicePostureRule,
-  type AccessRule,
-  type AnyValidServiceTokenRule,
-  type AuthenticationMethodRule,
-  type AzureGroupRule,
-  type CertificateRule,
-  type CountryRule,
-  type DomainRule,
-  type EmailListRule,
-  type EmailRule,
-  type EveryoneRule,
-  type ExternalEvaluationRule,
-  type GitHubOrganizationRule,
-  type GroupRule,
-  type GSuiteGroupRule,
-  type IPListRule,
-  type IPRule,
-  type OktaGroupRule,
-  type SAMLGroupRule,
-  type ServiceTokenRule,
-} from './access';
-export { AccessUsersSinglePage, Users, type AccessUser, type UserListParams } from './users/index';
+  AccessUsersSinglePage,
+  UserListResponsesSinglePage,
+  Users,
+  type AccessUser,
+  type UserListResponse,
+  type UserListParams,
+} from './users/index';
 export {
   ApplicationListResponsesSinglePage,
   Applications,
@@ -158,9 +143,14 @@ export {
 } from './tags';
 export {
   ZeroTrustGroupsSinglePage,
+  GroupListResponsesSinglePage,
   Groups,
   type ZeroTrustGroup,
+  type GroupCreateResponse,
+  type GroupUpdateResponse,
+  type GroupListResponse,
   type GroupDeleteResponse,
+  type GroupGetResponse,
   type GroupCreateParams,
   type GroupUpdateParams,
   type GroupListParams,

package/src/resources/zero-trust/access/infrastructure/targets.ts

@@ -36,9 +36,8 @@ export class Targets extends APIResource {
   }
 
   /**
-   * Lists and sorts an account’s targets. Filters are optional and are ORed
-   * together. However, when a timestamp is specified with both its before and after
-   * counterparts, the timestamp filters are ANDed.
+   * Lists and sorts an account’s targets. Filters are optional and are ANDed
+   * together.
    */
   list(
     params: TargetListParams,
@@ -675,6 +674,12 @@ export interface TargetListParams extends V4PagePaginationArrayParams {
    */
   hostname_contains?: string | null;
 
+  /**
+   * Query param: Filters for targets whose IP addresses look like the specified
+   * string. Supports `*` as a wildcard character
+   */
+  ip_like?: string | null;
+
   /**
    * Query param: IPv4 address of the target
    */
@@ -691,6 +696,30 @@ export interface TargetListParams extends V4PagePaginationArrayParams {
    */
   ips?: Array<string>;
 
+  /**
+   * Query param: Defines an IPv4 filter range's ending value (inclusive). Requires
+   * `ipv4_start` to be specified as well.
+   */
+  ipv4_end?: string | null;
+
+  /**
+   * Query param: Defines an IPv4 filter range's starting value (inclusive). Requires
+   * `ipv4_end` to be specified as well.
+   */
+  ipv4_start?: string | null;
+
+  /**
+   * Query param: Defines an IPv6 filter range's ending value (inclusive). Requires
+   * `ipv6_start` to be specified as well.
+   */
+  ipv6_end?: string | null;
+
+  /**
+   * Query param: Defines an IPv6 filter range's starting value (inclusive). Requires
+   * `ipv6_end` to be specified as well.
+   */
+  ipv6_start?: string | null;
+
   /**
    * Query param: Date and time at which the target was modified after (inclusive)
    */
@@ -706,6 +735,12 @@ export interface TargetListParams extends V4PagePaginationArrayParams {
    */
   order?: 'hostname' | 'created_at';
 
+  /**
+   * Query param: Filters for targets that have any of the following UUIDs. Specify
+   * `target_ids` multiple times in query parameter to build list of candidates.
+   */
+  target_ids?: Array<string>;
+
   /**
    * Query param: Private virtual network identifier of the target
    */

package/src/resources/zero-trust/access/logs/access-requests.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../../resource';
 import * as Core from '../../../../core';
+import * as SCIMAPI from './scim/scim';
 
 export class AccessRequests extends APIResource {
   /**
@@ -21,51 +22,7 @@ export class AccessRequests extends APIResource {
   }
 }
 
-export interface AccessRequests {
-  /**
-   * The event that occurred, such as a login attempt.
-   */
-  action?: string;
-
-  /**
-   * The result of the authentication event.
-   */
-  allowed?: boolean;
-
-  /**
-   * The URL of the Access application.
-   */
-  app_domain?: string;
-
-  /**
-   * The unique identifier for the Access application.
-   */
-  app_uid?: string;
-
-  /**
-   * The IdP used to authenticate.
-   */
-  connection?: string;
-
-  created_at?: string;
-
-  /**
-   * The IP address of the authenticating user.
-   */
-  ip_address?: string;
-
-  /**
-   * The unique identifier for the request to Cloudflare.
-   */
-  ray_id?: string;
-
-  /**
-   * The email address of the authenticating user.
-   */
-  user_email?: string;
-}
-
-export type AccessRequestListResponse = Array<AccessRequests>;
+export type AccessRequestListResponse = Array<SCIMAPI.AccessRequest>;
 
 export interface AccessRequestListParams {
   /**
@@ -96,7 +53,6 @@ export interface AccessRequestListParams {
 
 export declare namespace AccessRequests {
   export {
-    type AccessRequests as AccessRequests,
     type AccessRequestListResponse as AccessRequestListResponse,
     type AccessRequestListParams as AccessRequestListParams,
   };

package/src/resources/zero-trust/access/logs/index.ts

@@ -6,3 +6,4 @@ export {
   type AccessRequestListParams,
 } from './access-requests';
 export { Logs } from './logs';
+export { SCIM, type AccessRequest } from './scim/index';

package/src/resources/zero-trust/access/logs/logs.ts

@@ -3,15 +3,23 @@
 import { APIResource } from '../../../../resource';
 import * as AccessRequestsAPI from './access-requests';
 import { AccessRequestListParams, AccessRequestListResponse, AccessRequests } from './access-requests';
+import * as SCIMAPI from './scim/scim';
+import { AccessRequest, SCIM } from './scim/scim';
 
 export class Logs extends APIResource {
   accessRequests: AccessRequestsAPI.AccessRequests = new AccessRequestsAPI.AccessRequests(this._client);
+  scim: SCIMAPI.SCIM = new SCIMAPI.SCIM(this._client);
 }
 
+Logs.AccessRequests = AccessRequests;
+Logs.SCIM = SCIM;
+
 export declare namespace Logs {
   export {
-    type AccessRequests as AccessRequests,
+    AccessRequests as AccessRequests,
     type AccessRequestListResponse as AccessRequestListResponse,
     type AccessRequestListParams as AccessRequestListParams,
   };
+
+  export { SCIM as SCIM, type AccessRequest as AccessRequest };
 }

package/src/resources/zero-trust/access/logs/scim/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { SCIM, type AccessRequest } from './scim';
+export {
+  UpdateListResponsesSinglePage,
+  Updates,
+  type UpdateListResponse,
+  type UpdateListParams,
+} from './updates';

package/src/resources/zero-trust/access/logs/scim/scim.ts

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../resource';
+import * as UpdatesAPI from './updates';
+import { UpdateListParams, UpdateListResponse, UpdateListResponsesSinglePage, Updates } from './updates';
+
+export class SCIM extends APIResource {
+  updates: UpdatesAPI.Updates = new UpdatesAPI.Updates(this._client);
+}
+
+export interface AccessRequest {
+  /**
+   * The event that occurred, such as a login attempt.
+   */
+  action?: string;
+
+  /**
+   * The result of the authentication event.
+   */
+  allowed?: boolean;
+
+  /**
+   * The URL of the Access application.
+   */
+  app_domain?: string;
+
+  /**
+   * The unique identifier for the Access application.
+   */
+  app_uid?: string;
+
+  /**
+   * The IdP used to authenticate.
+   */
+  connection?: string;
+
+  created_at?: string;
+
+  /**
+   * The IP address of the authenticating user.
+   */
+  ip_address?: string;
+
+  /**
+   * The unique identifier for the request to Cloudflare.
+   */
+  ray_id?: string;
+
+  /**
+   * The email address of the authenticating user.
+   */
+  user_email?: string;
+}
+
+SCIM.Updates = Updates;
+SCIM.UpdateListResponsesSinglePage = UpdateListResponsesSinglePage;
+
+export declare namespace SCIM {
+  export { type AccessRequest as AccessRequest };
+
+  export {
+    Updates as Updates,
+    type UpdateListResponse as UpdateListResponse,
+    UpdateListResponsesSinglePage as UpdateListResponsesSinglePage,
+    type UpdateListParams as UpdateListParams,
+  };
+}