cloudflare 4.0.0 → 4.1.0

package/src/resources/zero-trust/access/applications/policy-tests/index.ts

@@ -7,4 +7,4 @@ export {
   type PolicyTestCreateParams,
   type PolicyTestGetParams,
 } from './policy-tests';
-export { Users, type UserListResponse, type UserListParams } from './users';
+export { UserListResponsesSinglePage, Users, type UserListResponse, type UserListParams } from './users';

package/src/resources/zero-trust/access/applications/policy-tests/policy-tests.ts

@@ -2,11 +2,11 @@
 
 import { APIResource } from '../../../../../resource';
 import * as Core from '../../../../../core';
-import * as AccessAPI from '../../access';
 import * as PoliciesAPI from '../../policies';
 import * as ApplicationsAPI from '../applications';
+import * as ApplicationsPoliciesAPI from '../policies';
 import * as UsersAPI from './users';
-import { UserListParams, UserListResponse, Users } from './users';
+import { UserListParams, UserListResponse, UserListResponsesSinglePage, Users } from './users';
 
 export class PolicyTests extends APIResource {
   users: UsersAPI.Users = new UsersAPI.Users(this._client);
@@ -19,7 +19,12 @@ export class PolicyTests extends APIResource {
     options?: Core.RequestOptions,
   ): Core.APIPromise<PolicyTestCreateResponse> {
     const { account_id, ...body } = params;
-    return this._client.post(`/accounts/${account_id}/access/policy-tests`, { body, ...options });
+    return (
+      this._client.post(`/accounts/${account_id}/access/policy-tests`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: PolicyTestCreateResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 
   /**
@@ -30,8 +35,13 @@ export class PolicyTests extends APIResource {
     params: PolicyTestGetParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<PolicyTestGetResponse> {
-    const { account_id } = params;
-    return this._client.get(`/accounts/${account_id}/access/policy-tests/${policyTestId}`, options);
+    const { account_id, ...query } = params;
+    return (
+      this._client.get(`/accounts/${account_id}/access/policy-tests/${policyTestId}`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: PolicyTestGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
   }
 }
 
@@ -101,85 +111,93 @@ export interface PolicyTestCreateParams {
   account_id: string;
 
   /**
-   * Body param: The UUID of the policy
+   * Body param:
    */
-  id?: string;
-
-  /**
-   * Body param: Administrators who can approve a temporary authentication request.
-   */
-  approval_groups?: Array<PoliciesAPI.ApprovalGroupParam>;
-
-  /**
-   * Body param: Requires the user to request access from an administrator at the
-   * start of each session.
-   */
-  approval_required?: boolean;
-
-  /**
-   * Body param: The action Access will take if a user matches this policy.
-   * Infrastructure application policies can only use the Allow action.
-   */
-  decision?: ApplicationsAPI.DecisionParam;
-
-  /**
-   * Body param: Rules evaluated with a NOT logical operator. To match the policy, a
-   * user cannot meet any of the Exclude rules.
-   */
-  exclude?: Array<AccessAPI.AccessRuleParam>;
-
-  /**
-   * Body param: Rules evaluated with an OR logical operator. A user needs to meet
-   * only one of the Include rules.
-   */
-  include?: Array<AccessAPI.AccessRuleParam>;
-
-  /**
-   * Body param: Require this application to be served in an isolated browser for
-   * users matching this policy. 'Client Web Isolation' must be on for the account in
-   * order to use this feature.
-   */
-  isolation_required?: boolean;
-
-  /**
-   * Body param: The name of the Access policy.
-   */
-  name?: string;
-
-  /**
-   * Body param: A custom message that will appear on the purpose justification
-   * screen.
-   */
-  purpose_justification_prompt?: string;
-
-  /**
-   * Body param: Require users to enter a justification when they log in to the
-   * application.
-   */
-  purpose_justification_required?: boolean;
-
-  /**
-   * Body param: Rules evaluated with an AND logical operator. To match the policy, a
-   * user must meet all of the Require rules.
-   */
-  require?: Array<AccessAPI.AccessRuleParam>;
+  policies?: Array<PolicyTestCreateParams.Policy>;
+}
 
-  /**
-   * Body param: The amount of time that tokens issued for the application will be
-   * valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us
-   * (or µs), ms, s, m, h.
-   */
-  session_duration?: string;
+export namespace PolicyTestCreateParams {
+  export interface Policy {
+    /**
+     * The action Access will take if a user matches this policy. Infrastructure
+     * application policies can only use the Allow action.
+     */
+    decision: ApplicationsAPI.DecisionParam;
+
+    /**
+     * Rules evaluated with an OR logical operator. A user needs to meet only one of
+     * the Include rules.
+     */
+    include: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
+
+    /**
+     * The name of the Access policy.
+     */
+    name: string;
+
+    /**
+     * Administrators who can approve a temporary authentication request.
+     */
+    approval_groups?: Array<PoliciesAPI.ApprovalGroupParam>;
+
+    /**
+     * Requires the user to request access from an administrator at the start of each
+     * session.
+     */
+    approval_required?: boolean;
+
+    /**
+     * Rules evaluated with a NOT logical operator. To match the policy, a user cannot
+     * meet any of the Exclude rules.
+     */
+    exclude?: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
+
+    /**
+     * Require this application to be served in an isolated browser for users matching
+     * this policy. 'Client Web Isolation' must be on for the account in order to use
+     * this feature.
+     */
+    isolation_required?: boolean;
+
+    /**
+     * A custom message that will appear on the purpose justification screen.
+     */
+    purpose_justification_prompt?: string;
+
+    /**
+     * Require users to enter a justification when they log in to the application.
+     */
+    purpose_justification_required?: boolean;
+
+    /**
+     * Rules evaluated with an AND logical operator. To match the policy, a user must
+     * meet all of the Require rules.
+     */
+    require?: Array<ApplicationsPoliciesAPI.AccessRuleParam>;
+
+    /**
+     * The amount of time that tokens issued for the application will be valid. Must be
+     * in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s,
+     * m, h.
+     */
+    session_duration?: string;
+  }
 }
 
 export interface PolicyTestGetParams {
   /**
-   * Identifier
+   * Path param: Identifier
    */
   account_id: string;
+
+  /**
+   * Query param:
+   */
+  page?: number;
 }
 
 PolicyTests.Users = Users;
+PolicyTests.UserListResponsesSinglePage = UserListResponsesSinglePage;
 
 export declare namespace PolicyTests {
   export {
@@ -189,5 +207,10 @@ export declare namespace PolicyTests {
     type PolicyTestGetParams as PolicyTestGetParams,
   };
 
-  export { Users as Users, type UserListResponse as UserListResponse, type UserListParams as UserListParams };
+  export {
+    Users as Users,
+    type UserListResponse as UserListResponse,
+    UserListResponsesSinglePage as UserListResponsesSinglePage,
+    type UserListParams as UserListParams,
+  };
 }

package/src/resources/zero-trust/access/applications/policy-tests/users.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../../../resource';
 import * as Core from '../../../../../core';
+import { SinglePage } from '../../../../../pagination';
 
 export class Users extends APIResource {
   /**
@@ -11,39 +12,38 @@ export class Users extends APIResource {
     policyTestId: string,
     params: UserListParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<UserListResponse> {
+  ): Core.PagePromise<UserListResponsesSinglePage, UserListResponse> {
     const { account_id } = params;
-    return this._client.get(`/accounts/${account_id}/access/policy-tests/${policyTestId}/users`, options);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/access/policy-tests/${policyTestId}/users`,
+      UserListResponsesSinglePage,
+      options,
+    );
   }
 }
 
-/**
- * Page of processed users.
- */
-export type UserListResponse = Array<UserListResponse.UserListResponseItem>;
-
-export namespace UserListResponse {
-  export interface UserListResponseItem {
-    /**
-     * UUID
-     */
-    id?: string;
-
-    /**
-     * The email of the user.
-     */
-    email?: string;
-
-    /**
-     * The name of the user.
-     */
-    name?: string;
-
-    /**
-     * Policy evaluation result for an individual user.
-     */
-    status?: 'approved' | 'blocked';
-  }
+export class UserListResponsesSinglePage extends SinglePage<UserListResponse> {}
+
+export interface UserListResponse {
+  /**
+   * UUID
+   */
+  id?: string;
+
+  /**
+   * The email of the user.
+   */
+  email?: string;
+
+  /**
+   * The name of the user.
+   */
+  name?: string;
+
+  /**
+   * Policy evaluation result for an individual user.
+   */
+  status?: 'approved' | 'blocked';
 }
 
 export interface UserListParams {
@@ -53,6 +53,12 @@ export interface UserListParams {
   account_id: string;
 }
 
+Users.UserListResponsesSinglePage = UserListResponsesSinglePage;
+
 export declare namespace Users {
-  export { type UserListResponse as UserListResponse, type UserListParams as UserListParams };
+  export {
+    type UserListResponse as UserListResponse,
+    UserListResponsesSinglePage as UserListResponsesSinglePage,
+    type UserListParams as UserListParams,
+  };
 }

package/src/resources/zero-trust/access/applications/user-policy-checks.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../../../resource';
 import { isRequestOptions } from '../../../../core';
 import * as Core from '../../../../core';
-import { CloudflareError } from "../../../../error";
 import * as UserPolicyChecksAPI from './user-policy-checks';
 import * as ApplicationsAPI from './applications';
+import { CloudflareError } from '../../../../error';
 
 export class UserPolicyChecks extends APIResource {
   /**

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

@@ -3,16 +3,15 @@
 import { APIResource } from '../../../../resource';
 import { isRequestOptions } from '../../../../core';
 import * as Core from '../../../../core';
-import { CloudflareError } from "../../../../error";
 import * as SettingsAPI from './settings';
 import {
   CertificateSettings,
+  CertificateSettingsSinglePage,
   SettingGetParams,
-  SettingGetResponse,
   SettingUpdateParams,
-  SettingUpdateResponse,
   Settings,
 } from './settings';
+import { CloudflareError } from '../../../../error';
 import { SinglePage } from '../../../../pagination';
 
 export class Certificates extends APIResource {
@@ -342,6 +341,7 @@ export interface CertificateGetParams {
 
 Certificates.CertificatesSinglePage = CertificatesSinglePage;
 Certificates.Settings = Settings;
+Certificates.CertificateSettingsSinglePage = CertificateSettingsSinglePage;
 
 export declare namespace Certificates {
   export {
@@ -359,8 +359,7 @@ export declare namespace Certificates {
   export {
     Settings as Settings,
     type CertificateSettings as CertificateSettings,
-    type SettingUpdateResponse as SettingUpdateResponse,
-    type SettingGetResponse as SettingGetResponse,
+    CertificateSettingsSinglePage as CertificateSettingsSinglePage,
     type SettingUpdateParams as SettingUpdateParams,
     type SettingGetParams as SettingGetParams,
   };

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

@@ -1,5 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  CertificateSettingsSinglePage,
+  Settings,
+  type CertificateSettings,
+  type SettingUpdateParams,
+  type SettingGetParams,
+} from './settings';
 export {
   CertificatesSinglePage,
   Certificates,
@@ -12,11 +19,3 @@ export {
   type CertificateDeleteParams,
   type CertificateGetParams,
 } from './certificates';
-export {
-  Settings,
-  type CertificateSettings,
-  type SettingUpdateResponse,
-  type SettingGetResponse,
-  type SettingUpdateParams,
-  type SettingGetParams,
-} from './settings';

package/src/resources/zero-trust/access/certificates/settings.ts

@@ -3,13 +3,17 @@
 import { APIResource } from '../../../../resource';
 import { isRequestOptions } from '../../../../core';
 import * as Core from '../../../../core';
-import { CloudflareError } from "../../../../error";
+import { CloudflareError } from '../../../../error';
+import { SinglePage } from '../../../../pagination';
 
 export class Settings extends APIResource {
   /**
    * Updates an mTLS certificate's hostname settings.
    */
-  update(params: SettingUpdateParams, options?: Core.RequestOptions): Core.APIPromise<SettingUpdateResponse> {
+  update(
+    params: SettingUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CertificateSettingsSinglePage, CertificateSettings> {
     const { account_id, zone_id, ...body } = params;
     if (!account_id && !zone_id) {
       throw new CloudflareError('You must provide either account_id or zone_id.');
@@ -27,23 +31,25 @@ export class Settings extends APIResource {
           accountOrZone: 'zones',
           accountOrZoneId: zone_id,
         };
-    return (
-      this._client.put(`/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: SettingUpdateResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
+      CertificateSettingsSinglePage,
+      { body, method: 'put', ...options },
+    );
   }
 
   /**
    * List all mTLS hostname settings for this account or zone.
    */
-  get(params?: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse>;
-  get(options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse>;
+  get(
+    params?: SettingGetParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CertificateSettingsSinglePage, CertificateSettings>;
+  get(options?: Core.RequestOptions): Core.PagePromise<CertificateSettingsSinglePage, CertificateSettings>;
   get(
     params: SettingGetParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.APIPromise<SettingGetResponse> {
+  ): Core.PagePromise<CertificateSettingsSinglePage, CertificateSettings> {
     if (isRequestOptions(params)) {
       return this.get({}, params);
     }
@@ -64,15 +70,16 @@ export class Settings extends APIResource {
           accountOrZone: 'zones',
           accountOrZoneId: zone_id,
         };
-    return (
-      this._client.get(
-        `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
-        options,
-      ) as Core.APIPromise<{ result: SettingGetResponse }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/${accountOrZone}/${accountOrZoneId}/access/certificates/settings`,
+      CertificateSettingsSinglePage,
+      options,
+    );
   }
 }
 
+export class CertificateSettingsSinglePage extends SinglePage<CertificateSettings> {}
+
 export interface CertificateSettings {
   /**
    * Request client certificates for this hostname in China. Can only be set to true
@@ -113,10 +120,6 @@ export interface CertificateSettingsParam {
   hostname: string;
 }
 
-export type SettingUpdateResponse = Array<CertificateSettings>;
-
-export type SettingGetResponse = Array<CertificateSettings>;
-
 export interface SettingUpdateParams {
   /**
    * Body param:
@@ -148,11 +151,12 @@ export interface SettingGetParams {
   zone_id?: string;
 }
 
+Settings.CertificateSettingsSinglePage = CertificateSettingsSinglePage;
+
 export declare namespace Settings {
   export {
     type CertificateSettings as CertificateSettings,
-    type SettingUpdateResponse as SettingUpdateResponse,
-    type SettingGetResponse as SettingGetResponse,
+    CertificateSettingsSinglePage as CertificateSettingsSinglePage,
     type SettingUpdateParams as SettingUpdateParams,
     type SettingGetParams as SettingGetParams,
   };