cloudflare 6.4.0 → 6.5.0

package/src/resources/ssl/auto-origin-tls-kex.ts

@@ -1,5 +1,114 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 
-export class AutoOriginTLSKex extends APIResource {}
+export class AutoOriginTLSKex extends APIResource {
+  /**
+   * Enable or disable Auto-Origin TLS KEX selection for the zone by sending
+   * `{"enabled": true}` or `{"enabled": false}`. When enabled, Cloudflare runs a
+   * periodic scan of the zone's origins to determine the preferred key-exchange
+   * algorithm and writes that preference to the edge so it is sent first in the TLS
+   * ClientHello to the origin.
+   *
+   * @example
+   * ```ts
+   * const response = await client.ssl.autoOriginTLSKex.edit({
+   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   enabled: true,
+   * });
+   * ```
+   */
+  edit(
+    params: AutoOriginTLSKexEditParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AutoOriginTLSKexEditResponse> {
+    const { zone_id, ...body } = params;
+    return (
+      this._client.patch(`/zones/${zone_id}/settings/auto_origin_tls_kex`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: AutoOriginTLSKexEditResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * When enabled, Cloudflare automatically selects the preferred TLS key-exchange
+   * algorithm to use when establishing the TLS connection to the zone's origin,
+   * picking from the algorithms permitted by the zone's
+   * `origin_tls_compliance_modes` setting. When disabled, the default key-exchange
+   * ordering is used.
+   *
+   * @example
+   * ```ts
+   * const autoOriginTLSKex =
+   *   await client.ssl.autoOriginTLSKex.get({
+   *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
+   *   });
+   * ```
+   */
+  get(
+    params: AutoOriginTLSKexGetParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AutoOriginTLSKexGetResponse> {
+    const { zone_id } = params;
+    return (
+      this._client.get(`/zones/${zone_id}/settings/auto_origin_tls_kex`, options) as Core.APIPromise<{
+        result: AutoOriginTLSKexGetResponse;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface AutoOriginTLSKexEditResponse {
+  id: string;
+
+  /**
+   * Whether Auto-Origin TLS KEX selection is enabled for the zone.
+   */
+  enabled: boolean;
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on: string;
+}
+
+export interface AutoOriginTLSKexGetResponse {
+  id: string;
+
+  /**
+   * Whether Auto-Origin TLS KEX selection is enabled for the zone.
+   */
+  enabled: boolean;
+
+  /**
+   * Last time this setting was modified.
+   */
+  modified_on: string;
+}
+
+export interface AutoOriginTLSKexEditParams {
+  /**
+   * Path param
+   */
+  zone_id: string;
+
+  /**
+   * Body param: Controls enablement of Auto-Origin TLS KEX selection for the zone.
+   */
+  enabled: boolean;
+}
+
+export interface AutoOriginTLSKexGetParams {
+  zone_id: string;
+}
+
+export declare namespace AutoOriginTLSKex {
+  export {
+    type AutoOriginTLSKexEditResponse as AutoOriginTLSKexEditResponse,
+    type AutoOriginTLSKexGetResponse as AutoOriginTLSKexGetResponse,
+    type AutoOriginTLSKexEditParams as AutoOriginTLSKexEditParams,
+    type AutoOriginTLSKexGetParams as AutoOriginTLSKexGetParams,
+  };
+}

package/src/resources/ssl/index.ts

@@ -1,7 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Analyze, type AnalyzeCreateResponse, type AnalyzeCreateParams } from './analyze';
-export { AutoOriginTLSKex } from './auto-origin-tls-kex';
+export {
+  AutoOriginTLSKex,
+  type AutoOriginTLSKexEditResponse,
+  type AutoOriginTLSKexGetResponse,
+  type AutoOriginTLSKexEditParams,
+  type AutoOriginTLSKexGetParams,
+} from './auto-origin-tls-kex';
 export {
   CertificatePackListResponsesV4PagePaginationArray,
   CertificatePacks,
@@ -20,11 +26,7 @@ export {
   type CertificatePackEditParams,
   type CertificatePackGetParams,
 } from './certificate-packs/index';
-export {
-  Recommendations,
-  type RecommendationGetResponse,
-  type RecommendationGetParams,
-} from './recommendations';
+export { Recommendations } from './recommendations';
 export { SSL } from './ssl';
 export { Universal } from './universal/index';
 export {

package/src/resources/ssl/recommendations.ts

@@ -1,58 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
-import * as Core from '../../core';
 
-export class Recommendations extends APIResource {
-  /**
-   * Retrieve the SSL/TLS Recommender's recommendation for a zone.
-   *
-   * @deprecated SSL/TLS Recommender has been decommissioned in favor of Automatic SSL/TLS
-   */
-  get(
-    params: RecommendationGetParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RecommendationGetResponse> {
-    const { zone_id } = params;
-    return (
-      this._client.get(`/zones/${zone_id}/ssl/recommendation`, options) as Core.APIPromise<{
-        result: RecommendationGetResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-}
-
-export interface RecommendationGetResponse {
-  id: string;
-
-  /**
-   * Whether this setting can be updated or not.
-   */
-  editable: boolean;
-
-  /**
-   * Last time this setting was modified.
-   */
-  modified_on: string;
-
-  /**
-   * Current setting of the automatic SSL/TLS.
-   */
-  value: 'auto' | 'custom';
-
-  /**
-   * Next time this zone will be scanned by the Automatic SSL/TLS.
-   */
-  next_scheduled_scan?: string | null;
-}
-
-export interface RecommendationGetParams {
-  zone_id: string;
-}
-
-export declare namespace Recommendations {
-  export {
-    type RecommendationGetResponse as RecommendationGetResponse,
-    type RecommendationGetParams as RecommendationGetParams,
-  };
-}
+export class Recommendations extends APIResource {}

package/src/resources/ssl/ssl.ts

@@ -4,9 +4,15 @@ import { APIResource } from '../../resource';
 import * as AnalyzeAPI from './analyze';
 import { Analyze, AnalyzeCreateParams, AnalyzeCreateResponse } from './analyze';
 import * as AutoOriginTLSKexAPI from './auto-origin-tls-kex';
-import { AutoOriginTLSKex } from './auto-origin-tls-kex';
+import {
+  AutoOriginTLSKex,
+  AutoOriginTLSKexEditParams,
+  AutoOriginTLSKexEditResponse,
+  AutoOriginTLSKexGetParams,
+  AutoOriginTLSKexGetResponse,
+} from './auto-origin-tls-kex';
 import * as RecommendationsAPI from './recommendations';
-import { RecommendationGetParams, RecommendationGetResponse, Recommendations } from './recommendations';
+import { Recommendations } from './recommendations';
 import * as VerificationAPI from './verification';
 import {
   Verification,
@@ -85,14 +91,16 @@ export declare namespace SSL {
     type CertificatePackGetParams as CertificatePackGetParams,
   };
 
+  export { Recommendations as Recommendations };
+
   export {
-    Recommendations as Recommendations,
-    type RecommendationGetResponse as RecommendationGetResponse,
-    type RecommendationGetParams as RecommendationGetParams,
+    AutoOriginTLSKex as AutoOriginTLSKex,
+    type AutoOriginTLSKexEditResponse as AutoOriginTLSKexEditResponse,
+    type AutoOriginTLSKexGetResponse as AutoOriginTLSKexGetResponse,
+    type AutoOriginTLSKexEditParams as AutoOriginTLSKexEditParams,
+    type AutoOriginTLSKexGetParams as AutoOriginTLSKexGetParams,
   };
 
-  export { AutoOriginTLSKex as AutoOriginTLSKex };
-
   export { Universal as Universal };
 
   export {

package/src/resources/tenants/account-types.ts

@@ -0,0 +1,34 @@
+// 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 AccountTypes extends APIResource {
+  /**
+   * List of account types available for the Tenant to provision accounts.
+   */
+  list(
+    tenantId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AccountTypeListResponsesSinglePage, AccountTypeListResponse> {
+    return this._client.getAPIList(
+      `/tenants/${tenantId}/account_types`,
+      AccountTypeListResponsesSinglePage,
+      options,
+    );
+  }
+}
+
+export class AccountTypeListResponsesSinglePage extends SinglePage<AccountTypeListResponse> {}
+
+export type AccountTypeListResponse = string;
+
+AccountTypes.AccountTypeListResponsesSinglePage = AccountTypeListResponsesSinglePage;
+
+export declare namespace AccountTypes {
+  export {
+    type AccountTypeListResponse as AccountTypeListResponse,
+    AccountTypeListResponsesSinglePage as AccountTypeListResponsesSinglePage,
+  };
+}

package/src/resources/tenants/accounts.ts

@@ -0,0 +1,63 @@
+// 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 Accounts extends APIResource {
+  /**
+   * List of accounts for the Tenant.
+   */
+  list(
+    tenantId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<TenantAccountsSinglePage, TenantAccount> {
+    return this._client.getAPIList(`/tenants/${tenantId}/accounts`, TenantAccountsSinglePage, options);
+  }
+}
+
+export class TenantAccountsSinglePage extends SinglePage<TenantAccount> {}
+
+export interface TenantAccount {
+  id: string;
+
+  created_on: string;
+
+  name: string | null;
+
+  settings: TenantAccount.Settings;
+
+  type: 'standard' | 'enterprise';
+}
+
+export namespace TenantAccount {
+  export interface Settings {
+    abuse_contact_email: string | null;
+
+    access_approval_expiry: string | null;
+
+    api_access_enabled: boolean | null;
+
+    /**
+     * @deprecated Use
+     * [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings)
+     * instead. Deprecated.
+     */
+    default_nameservers: string | null;
+
+    enforce_twofactor: boolean | null;
+
+    /**
+     * @deprecated Use
+     * [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings)
+     * instead. Deprecated.
+     */
+    use_account_custom_ns_by_default: boolean | null;
+  }
+}
+
+Accounts.TenantAccountsSinglePage = TenantAccountsSinglePage;
+
+export declare namespace Accounts {
+  export { type TenantAccount as TenantAccount, TenantAccountsSinglePage as TenantAccountsSinglePage };
+}

package/src/resources/tenants/api.md

@@ -0,0 +1,49 @@
+# Tenants
+
+Types:
+
+- <code><a href="./src/resources/tenants/tenants.ts">Tenant</a></code>
+
+Methods:
+
+- <code title="get /tenants/{tenant_id}">client.tenants.<a href="./src/resources/tenants/tenants.ts">get</a>(tenantId) -> Tenant</code>
+
+## AccountTypes
+
+Types:
+
+- <code><a href="./src/resources/tenants/account-types.ts">AccountTypeListResponse</a></code>
+
+Methods:
+
+- <code title="get /tenants/{tenant_id}/account_types">client.tenants.accountTypes.<a href="./src/resources/tenants/account-types.ts">list</a>(tenantId) -> AccountTypeListResponsesSinglePage</code>
+
+## Accounts
+
+Types:
+
+- <code><a href="./src/resources/tenants/accounts.ts">TenantAccount</a></code>
+
+Methods:
+
+- <code title="get /tenants/{tenant_id}/accounts">client.tenants.accounts.<a href="./src/resources/tenants/accounts.ts">list</a>(tenantId) -> TenantAccountsSinglePage</code>
+
+## Entitlements
+
+Types:
+
+- <code><a href="./src/resources/tenants/entitlements.ts">TenantEntitlements</a></code>
+
+Methods:
+
+- <code title="get /tenants/{tenant_id}/entitlements">client.tenants.entitlements.<a href="./src/resources/tenants/entitlements.ts">get</a>(tenantId) -> TenantEntitlements</code>
+
+## Memberships
+
+Types:
+
+- <code><a href="./src/resources/tenants/memberships.ts">TenantMembership</a></code>
+
+Methods:
+
+- <code title="get /tenants/{tenant_id}/memberships">client.tenants.memberships.<a href="./src/resources/tenants/memberships.ts">list</a>(tenantId) -> TenantMembershipsSinglePage</code>

package/src/resources/tenants/entitlements.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Entitlements extends APIResource {
+  /**
+   * List of innate entitlements available for the Tenant.
+   */
+  get(tenantId: string, options?: Core.RequestOptions): Core.APIPromise<TenantEntitlements> {
+    return (
+      this._client.get(`/tenants/${tenantId}/entitlements`, options) as Core.APIPromise<{
+        result: TenantEntitlements;
+      }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface TenantEntitlements {
+  allow_add_subdomain: TenantEntitlements.AllowAddSubdomain;
+
+  allow_auto_accept_invites: TenantEntitlements.AllowAutoAcceptInvites;
+
+  cname_setup_allowed: TenantEntitlements.CNAMESetupAllowed;
+
+  custom_entitlements: Array<TenantEntitlements.CustomEntitlement> | null;
+
+  mhs_certificate_count: TenantEntitlements.MhsCertificateCount;
+
+  partial_setup_allowed: TenantEntitlements.PartialSetupAllowed;
+}
+
+export namespace TenantEntitlements {
+  export interface AllowAddSubdomain {
+    type: 'bool';
+
+    value: boolean;
+  }
+
+  export interface AllowAutoAcceptInvites {
+    type: 'bool';
+
+    value: boolean;
+  }
+
+  export interface CNAMESetupAllowed {
+    type: 'bool';
+
+    value: boolean;
+  }
+
+  export interface CustomEntitlement {
+    allocation:
+      | CustomEntitlement.OrganizationsAPIMaxCountAllocation
+      | CustomEntitlement.OrganizationsAPIBoolAllocation
+      | CustomEntitlement.OrganizationsAPINullAllocation;
+
+    feature: CustomEntitlement.Feature;
+  }
+
+  export namespace CustomEntitlement {
+    export interface OrganizationsAPIMaxCountAllocation {
+      type: 'max_count';
+
+      value: number;
+    }
+
+    export interface OrganizationsAPIBoolAllocation {
+      type: 'bool';
+
+      value: boolean;
+    }
+
+    export interface OrganizationsAPINullAllocation {
+      type: '';
+
+      value?: unknown;
+    }
+
+    export interface Feature {
+      key: string;
+    }
+  }
+
+  export interface MhsCertificateCount {
+    type: 'max_count';
+
+    value: number;
+  }
+
+  export interface PartialSetupAllowed {
+    type: 'bool';
+
+    value: boolean;
+  }
+}
+
+export declare namespace Entitlements {
+  export { type TenantEntitlements as TenantEntitlements };
+}

package/src/resources/tenants/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AccountTypeListResponsesSinglePage,
+  AccountTypes,
+  type AccountTypeListResponse,
+} from './account-types';
+export { Entitlements, type TenantEntitlements } from './entitlements';
+export { TenantAccountsSinglePage, Accounts, type TenantAccount } from './accounts';
+export { TenantMembershipsSinglePage, Memberships, type TenantMembership } from './memberships';
+export { Tenants } from './tenants';

package/src/resources/tenants/memberships.ts

@@ -0,0 +1,36 @@
+// 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 Memberships extends APIResource {
+  /**
+   * List of active members (Cloudflare users) for the Tenant.
+   */
+  list(
+    tenantId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<TenantMembershipsSinglePage, TenantMembership> {
+    return this._client.getAPIList(`/tenants/${tenantId}/memberships`, TenantMembershipsSinglePage, options);
+  }
+}
+
+export class TenantMembershipsSinglePage extends SinglePage<TenantMembership> {}
+
+export interface TenantMembership {
+  user_email: string;
+
+  user_name: string;
+
+  user_tag: string;
+}
+
+Memberships.TenantMembershipsSinglePage = TenantMembershipsSinglePage;
+
+export declare namespace Memberships {
+  export {
+    type TenantMembership as TenantMembership,
+    TenantMembershipsSinglePage as TenantMembershipsSinglePage,
+  };
+}

package/src/resources/tenants/tenants.ts

@@ -0,0 +1,124 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as AccountTypesAPI from './account-types';
+import { AccountTypeListResponse, AccountTypeListResponsesSinglePage, AccountTypes } from './account-types';
+import * as AccountsAPI from './accounts';
+import { Accounts, TenantAccount, TenantAccountsSinglePage } from './accounts';
+import * as EntitlementsAPI from './entitlements';
+import { Entitlements, TenantEntitlements } from './entitlements';
+import * as MembershipsAPI from './memberships';
+import { Memberships, TenantMembership, TenantMembershipsSinglePage } from './memberships';
+
+export class Tenants extends APIResource {
+  accountTypes: AccountTypesAPI.AccountTypes = new AccountTypesAPI.AccountTypes(this._client);
+  accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
+  entitlements: EntitlementsAPI.Entitlements = new EntitlementsAPI.Entitlements(this._client);
+  memberships: MembershipsAPI.Memberships = new MembershipsAPI.Memberships(this._client);
+
+  /**
+   * Retrieves a Tenant by Tenant ID.
+   */
+  get(tenantId: string, options?: Core.RequestOptions): Core.APIPromise<Tenant> {
+    return (
+      this._client.get(`/tenants/${tenantId}`, options) as Core.APIPromise<{ result: Tenant }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export interface Tenant {
+  cdate: string;
+
+  edate: string;
+
+  tenant_contacts: Tenant.TenantContacts;
+
+  tenant_labels: Array<string>;
+
+  tenant_metadata: Tenant.TenantMetadata;
+
+  tenant_name: string;
+
+  tenant_network: unknown;
+
+  tenant_status: string;
+
+  tenant_tag: string;
+
+  tenant_type: string;
+
+  tenant_units: Array<Tenant.TenantUnit>;
+
+  customer_id?: string;
+}
+
+export namespace Tenant {
+  export interface TenantContacts {
+    email?: string;
+
+    website?: string;
+  }
+
+  export interface TenantMetadata {
+    dns?: TenantMetadata.DNS;
+  }
+
+  export namespace TenantMetadata {
+    export interface DNS {
+      ns_pool: DNS.NSPool;
+    }
+
+    export namespace DNS {
+      export interface NSPool {
+        primary?: string;
+
+        secondary?: string;
+      }
+    }
+  }
+
+  export interface TenantUnit {
+    unit_memberships: Array<unknown>;
+
+    unit_metadata: unknown;
+
+    unit_name: string;
+
+    unit_status: string;
+
+    unit_tag: string;
+  }
+}
+
+Tenants.AccountTypes = AccountTypes;
+Tenants.AccountTypeListResponsesSinglePage = AccountTypeListResponsesSinglePage;
+Tenants.Accounts = Accounts;
+Tenants.TenantAccountsSinglePage = TenantAccountsSinglePage;
+Tenants.Entitlements = Entitlements;
+Tenants.Memberships = Memberships;
+Tenants.TenantMembershipsSinglePage = TenantMembershipsSinglePage;
+
+export declare namespace Tenants {
+  export { type Tenant as Tenant };
+
+  export {
+    AccountTypes as AccountTypes,
+    type AccountTypeListResponse as AccountTypeListResponse,
+    AccountTypeListResponsesSinglePage as AccountTypeListResponsesSinglePage,
+  };
+
+  export {
+    Accounts as Accounts,
+    type TenantAccount as TenantAccount,
+    TenantAccountsSinglePage as TenantAccountsSinglePage,
+  };
+
+  export { Entitlements as Entitlements, type TenantEntitlements as TenantEntitlements };
+
+  export {
+    Memberships as Memberships,
+    type TenantMembership as TenantMembership,
+    TenantMembershipsSinglePage as TenantMembershipsSinglePage,
+  };
+}

package/src/resources/tenants.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './tenants/index';

package/src/resources/user/api.md

@@ -77,6 +77,12 @@ Methods:
 - <code title="delete /user/subscriptions/{identifier}">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">delete</a>(identifier) -> SubscriptionDeleteResponse</code>
 - <code title="get /user/subscriptions">client.user.subscriptions.<a href="./src/resources/user/subscriptions.ts">get</a>() -> SubscriptionsSinglePage</code>
 
+## Tenants
+
+Methods:
+
+- <code title="get /user/tenants">client.user.tenants.<a href="./src/resources/user/tenants.ts">list</a>() -> OrganizationsSinglePage</code>
+
 ## Tokens
 
 Types:

package/src/resources/user/index.ts

@@ -17,6 +17,7 @@ export {
   type SubscriptionDeleteResponse,
   type SubscriptionUpdateParams,
 } from './subscriptions';
+export { Tenants } from './tenants';
 export {
   Tokens,
   type TokenCreateResponse,