cloudflare 4.0.0 → 4.1.0

package/src/resources/security-center/insights/type.ts

@@ -0,0 +1,129 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../resource';
+import { isRequestOptions } from '../../../core';
+import * as Core from '../../../core';
+import * as IssuesAPI from '../../intel/attack-surface-report/issues';
+import { CloudflareError } from '../../../error';
+
+export class Type extends APIResource {
+  /**
+   * Get Security Center Insight Counts by Type
+   */
+  get(params?: TypeGetParams, options?: Core.RequestOptions): Core.APIPromise<TypeGetResponse>;
+  get(options?: Core.RequestOptions): Core.APIPromise<TypeGetResponse>;
+  get(
+    params: TypeGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TypeGetResponse> {
+    if (isRequestOptions(params)) {
+      return this.get({}, params);
+    }
+    const { account_id, zone_id, ...query } = params;
+    if (!account_id && !zone_id) {
+      throw new CloudflareError('You must provide either account_id or zone_id.');
+    }
+    if (account_id && zone_id) {
+      throw new CloudflareError('You cannot provide both account_id and zone_id.');
+    }
+    const { accountOrZone, accountOrZoneId } =
+      account_id ?
+        {
+          accountOrZone: 'accounts',
+          accountOrZoneId: account_id,
+        }
+      : {
+          accountOrZone: 'zones',
+          accountOrZoneId: zone_id,
+        };
+    return (
+      this._client.get(`/${accountOrZone}/${accountOrZoneId}/security-center/insights/type`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: TypeGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export type TypeGetResponse = Array<TypeGetResponse.TypeGetResponseItem>;
+
+export namespace TypeGetResponse {
+  export interface TypeGetResponseItem {
+    count?: number;
+
+    value?: string;
+  }
+}
+
+export interface TypeGetParams {
+  /**
+   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+   * Zone ID.
+   */
+  account_id?: string;
+
+  /**
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
+   */
+  zone_id?: string;
+
+  /**
+   * Query param:
+   */
+  dismissed?: boolean;
+
+  /**
+   * Query param:
+   */
+  issue_class?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'issue_class~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  issue_type?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  product?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'product~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  severity?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  subject?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'subject~neq'?: Array<string>;
+}
+
+export declare namespace Type {
+  export { type TypeGetResponse as TypeGetResponse, type TypeGetParams as TypeGetParams };
+}

package/src/resources/security-center/security-center.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as InsightsAPI from './insights/insights';
+import {
+  InsightDismissParams,
+  InsightDismissResponse,
+  InsightListParams,
+  InsightListResponse,
+  InsightListResponsesV4PagePagination,
+  Insights,
+} from './insights/insights';
+
+export class SecurityCenter extends APIResource {
+  insights: InsightsAPI.Insights = new InsightsAPI.Insights(this._client);
+}
+
+SecurityCenter.Insights = Insights;
+SecurityCenter.InsightListResponsesV4PagePagination = InsightListResponsesV4PagePagination;
+
+export declare namespace SecurityCenter {
+  export {
+    Insights as Insights,
+    type InsightListResponse as InsightListResponse,
+    type InsightDismissResponse as InsightDismissResponse,
+    InsightListResponsesV4PagePagination as InsightListResponsesV4PagePagination,
+    type InsightListParams as InsightListParams,
+    type InsightDismissParams as InsightDismissParams,
+  };
+}

package/src/resources/shared.ts

@@ -492,7 +492,17 @@ export interface RatePlan {
   /**
    * The ID of the rate plan.
    */
-  id?: string;
+  id?:
+    | 'free'
+    | 'lite'
+    | 'pro'
+    | 'pro_plus'
+    | 'business'
+    | 'enterprise'
+    | 'partners_free'
+    | 'partners_pro'
+    | 'partners_business'
+    | 'partners_enterprise';
 
   /**
    * The currency applied to the rate plan subscription.
@@ -532,7 +542,17 @@ export interface RatePlanParam {
   /**
    * The ID of the rate plan.
    */
-  id?: string;
+  id?:
+    | 'free'
+    | 'lite'
+    | 'pro'
+    | 'pro_plus'
+    | 'business'
+    | 'enterprise'
+    | 'partners_free'
+    | 'partners_pro'
+    | 'partners_business'
+    | 'partners_enterprise';
 
   /**
    * The currency applied to the rate plan subscription.
@@ -933,7 +953,9 @@ export type TokenValue = string;
 
 export class MembersV4PagePaginationArray extends V4PagePaginationArray<Member> {}
 
-export class RolesSinglePage extends SinglePage<Role> {}
+export class RolesV4PagePaginationArray extends V4PagePaginationArray<Role> {}
+
+export class SubscriptionsSinglePage extends SinglePage<Subscription> {}
 
 export class TokensV4PagePaginationArray extends V4PagePaginationArray<Token> {}
 

package/src/resources/snippets/index.ts

@@ -2,6 +2,7 @@
 
 export { Content, type ContentGetParams } from './content';
 export {
+  RuleUpdateResponsesSinglePage,
   RuleListResponsesSinglePage,
   Rules,
   type RuleUpdateResponse,

package/src/resources/snippets/rules.ts

@@ -9,13 +9,16 @@ export class Rules extends APIResource {
   /**
    * Put Rules
    */
-  update(params: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse> {
+  update(
+    params: RuleUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RuleUpdateResponsesSinglePage, RuleUpdateResponse> {
     const { zone_id, ...body } = params;
-    return (
-      this._client.put(`/zones/${zone_id}/snippets/snippet_rules`, { body, ...options }) as Core.APIPromise<{
-        result: RuleUpdateResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/zones/${zone_id}/snippets/snippet_rules`,
+      RuleUpdateResponsesSinglePage,
+      { body, method: 'put', ...options },
+    );
   }
 
   /**
@@ -42,26 +45,21 @@ export class Rules extends APIResource {
   }
 }
 
-export class RuleListResponsesSinglePage extends SinglePage<RuleListResponse> {}
+export class RuleUpdateResponsesSinglePage extends SinglePage<RuleUpdateResponse> {}
 
-/**
- * List of snippet rules
- */
-export type RuleUpdateResponse = Array<RuleUpdateResponse.RuleUpdateResponseItem>;
+export class RuleListResponsesSinglePage extends SinglePage<RuleListResponse> {}
 
-export namespace RuleUpdateResponse {
-  export interface RuleUpdateResponseItem {
-    description?: string;
+export interface RuleUpdateResponse {
+  description?: string;
 
-    enabled?: boolean;
+  enabled?: boolean;
 
-    expression?: string;
+  expression?: string;
 
-    /**
-     * Snippet identifying name
-     */
-    snippet_name?: string;
-  }
+  /**
+   * Snippet identifying name
+   */
+  snippet_name?: string;
 }
 
 export interface RuleListResponse {
@@ -129,6 +127,7 @@ export interface RuleDeleteParams {
   zone_id: string;
 }
 
+Rules.RuleUpdateResponsesSinglePage = RuleUpdateResponsesSinglePage;
 Rules.RuleListResponsesSinglePage = RuleListResponsesSinglePage;
 
 export declare namespace Rules {
@@ -136,6 +135,7 @@ export declare namespace Rules {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
+    RuleUpdateResponsesSinglePage as RuleUpdateResponsesSinglePage,
     RuleListResponsesSinglePage as RuleListResponsesSinglePage,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,

package/src/resources/snippets/snippets.ts

@@ -14,6 +14,7 @@ import {
   RuleListResponsesSinglePage,
   RuleUpdateParams,
   RuleUpdateResponse,
+  RuleUpdateResponsesSinglePage,
   Rules,
 } from './rules';
 import { SinglePage } from '../../pagination';
@@ -161,6 +162,7 @@ export interface SnippetGetParams {
 
 Snippets.Content = Content;
 Snippets.Rules = Rules;
+Snippets.RuleUpdateResponsesSinglePage = RuleUpdateResponsesSinglePage;
 Snippets.RuleListResponsesSinglePage = RuleListResponsesSinglePage;
 
 export declare namespace Snippets {
@@ -171,6 +173,7 @@ export declare namespace Snippets {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
+    RuleUpdateResponsesSinglePage as RuleUpdateResponsesSinglePage,
     RuleListResponsesSinglePage as RuleListResponsesSinglePage,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,

package/src/resources/ssl/index.ts

@@ -19,7 +19,11 @@ export {
   type CertificatePackEditParams,
   type CertificatePackGetParams,
 } from './certificate-packs/index';
-export { Recommendations, type RecommendationGetResponse } from './recommendations';
+export {
+  Recommendations,
+  type RecommendationGetResponse,
+  type RecommendationGetParams,
+} from './recommendations';
 export { SSL } from './ssl';
 export { Universal } from './universal/index';
 export {

package/src/resources/ssl/recommendations.ts

@@ -8,12 +8,13 @@ export class Recommendations extends APIResource {
    * Retrieve the SSL/TLS Recommender's recommendation for a zone.
    */
   get(
-    zoneIdentifier: string,
+    params: RecommendationGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<RecommendationGetResponse | null> {
+  ): Core.APIPromise<RecommendationGetResponse> {
+    const { zone_id } = params;
     return (
-      this._client.get(`/zones/${zoneIdentifier}/ssl/recommendation`, options) as Core.APIPromise<{
-        result: RecommendationGetResponse | null;
+      this._client.get(`/zones/${zone_id}/ssl/recommendation`, options) as Core.APIPromise<{
+        result: RecommendationGetResponse;
       }>
     )._thenUnwrap((obj) => obj.result);
   }
@@ -21,7 +22,7 @@ export class Recommendations extends APIResource {
 
 export interface RecommendationGetResponse {
   /**
-   * Identifier of a recommedation result.
+   * Identifier of a recommendation result.
    */
   id?: string;
 
@@ -30,6 +31,16 @@ export interface RecommendationGetResponse {
   value?: 'flexible' | 'full' | 'strict';
 }
 
+export interface RecommendationGetParams {
+  /**
+   * Identifier
+   */
+  zone_id: string;
+}
+
 export declare namespace Recommendations {
-  export { type RecommendationGetResponse as RecommendationGetResponse };
+  export {
+    type RecommendationGetResponse as RecommendationGetResponse,
+    type RecommendationGetParams as RecommendationGetParams,
+  };
 }

package/src/resources/ssl/ssl.ts

@@ -4,7 +4,7 @@ import { APIResource } from '../../resource';
 import * as AnalyzeAPI from './analyze';
 import { Analyze, AnalyzeCreateParams, AnalyzeCreateResponse } from './analyze';
 import * as RecommendationsAPI from './recommendations';
-import { RecommendationGetResponse, Recommendations } from './recommendations';
+import { RecommendationGetParams, RecommendationGetResponse, Recommendations } from './recommendations';
 import * as VerificationAPI from './verification';
 import {
   Verification,
@@ -79,7 +79,11 @@ export declare namespace SSL {
     type CertificatePackGetParams as CertificatePackGetParams,
   };
 
-  export { Recommendations as Recommendations, type RecommendationGetResponse as RecommendationGetResponse };
+  export {
+    Recommendations as Recommendations,
+    type RecommendationGetResponse as RecommendationGetResponse,
+    type RecommendationGetParams as RecommendationGetParams,
+  };
 
   export { Universal as Universal };
 

package/src/resources/stream/audio-tracks.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import { SinglePage } from '../../pagination';
 
 export class AudioTracks extends APIResource {
   /**
@@ -68,16 +69,18 @@ export class AudioTracks extends APIResource {
     identifier: string,
     params: AudioTrackGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<AudioTrackGetResponse> {
+  ): Core.PagePromise<AudioSinglePage, Audio> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/stream/${identifier}/audio`, options) as Core.APIPromise<{
-        result: AudioTrackGetResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/stream/${identifier}/audio`,
+      AudioSinglePage,
+      options,
+    );
   }
 }
 
+export class AudioSinglePage extends SinglePage<Audio> {}
+
 export interface Audio {
   /**
    * Denotes whether the audio track will be played by default in a player.
@@ -103,8 +106,6 @@ export interface Audio {
 
 export type AudioTrackDeleteResponse = string;
 
-export type AudioTrackGetResponse = Array<Audio>;
-
 export interface AudioTrackDeleteParams {
   /**
    * The account identifier tag.
@@ -159,11 +160,13 @@ export interface AudioTrackGetParams {
   account_id: string;
 }
 
+AudioTracks.AudioSinglePage = AudioSinglePage;
+
 export declare namespace AudioTracks {
   export {
     type Audio as Audio,
     type AudioTrackDeleteResponse as AudioTrackDeleteResponse,
-    type AudioTrackGetResponse as AudioTrackGetResponse,
+    AudioSinglePage as AudioSinglePage,
     type AudioTrackDeleteParams as AudioTrackDeleteParams,
     type AudioTrackCopyParams as AudioTrackCopyParams,
     type AudioTrackEditParams as AudioTrackEditParams,

package/src/resources/stream/captions/captions.ts

@@ -11,6 +11,7 @@ import {
   LanguageGetParams,
   LanguageUpdateParams,
 } from './language/language';
+import { SinglePage } from '../../../pagination';
 
 export class Captions extends APIResource {
   language: LanguageAPI.Language = new LanguageAPI.Language(this._client);
@@ -22,16 +23,18 @@ export class Captions extends APIResource {
     identifier: string,
     params: CaptionGetParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<CaptionGetResponse> {
+  ): Core.PagePromise<CaptionsSinglePage, Caption> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/stream/${identifier}/captions`, options) as Core.APIPromise<{
-        result: CaptionGetResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(
+      `/accounts/${account_id}/stream/${identifier}/captions`,
+      CaptionsSinglePage,
+      options,
+    );
   }
 }
 
+export class CaptionsSinglePage extends SinglePage<Caption> {}
+
 export interface Caption {
   /**
    * Whether the caption was generated via AI.
@@ -54,8 +57,6 @@ export interface Caption {
   status?: 'ready' | 'inprogress' | 'error';
 }
 
-export type CaptionGetResponse = Array<Caption>;
-
 export interface CaptionGetParams {
   /**
    * Identifier
@@ -63,12 +64,13 @@ export interface CaptionGetParams {
   account_id: string;
 }
 
+Captions.CaptionsSinglePage = CaptionsSinglePage;
 Captions.Language = Language;
 
 export declare namespace Captions {
   export {
     type Caption as Caption,
-    type CaptionGetResponse as CaptionGetResponse,
+    CaptionsSinglePage as CaptionsSinglePage,
     type CaptionGetParams as CaptionGetParams,
   };
 

package/src/resources/stream/captions/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Captions, type Caption, type CaptionGetResponse, type CaptionGetParams } from './captions';
+export { CaptionsSinglePage, Captions, type Caption, type CaptionGetParams } from './captions';
 export {
   Language,
   type LanguageDeleteResponse,

package/src/resources/stream/index.ts

@@ -1,16 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
+  AudioSinglePage,
   AudioTracks,
   type Audio,
   type AudioTrackDeleteResponse,
-  type AudioTrackGetResponse,
   type AudioTrackDeleteParams,
   type AudioTrackCopyParams,
   type AudioTrackEditParams,
   type AudioTrackGetParams,
 } from './audio-tracks';
-export { Captions, type Caption, type CaptionGetResponse, type CaptionGetParams } from './captions/index';
+export { CaptionsSinglePage, Captions, type Caption, type CaptionGetParams } from './captions/index';
 export { ClipResource, type Clip, type ClipCreateParams } from './clip';
 export { Copy, type CopyCreateParams } from './copy';
 export {
@@ -29,6 +29,7 @@ export {
 } from './downloads';
 export { Embed, type EmbedGetResponse, type EmbedGetParams } from './embed';
 export {
+  KeyGetResponsesSinglePage,
   Keys,
   type KeyDeleteResponse,
   type KeyGetResponse,

package/src/resources/stream/keys.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import { SinglePage } from '../../pagination';
 
 export class Keys extends APIResource {
   /**
@@ -38,16 +39,17 @@ export class Keys extends APIResource {
   /**
    * Lists the video ID and creation date and time when a signing key was created.
    */
-  get(params: KeyGetParams, options?: Core.RequestOptions): Core.APIPromise<KeyGetResponse> {
+  get(
+    params: KeyGetParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<KeyGetResponsesSinglePage, KeyGetResponse> {
     const { account_id } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/stream/keys`, options) as Core.APIPromise<{
-        result: KeyGetResponse;
-      }>
-    )._thenUnwrap((obj) => obj.result);
+    return this._client.getAPIList(`/accounts/${account_id}/stream/keys`, KeyGetResponsesSinglePage, options);
   }
 }
 
+export class KeyGetResponsesSinglePage extends SinglePage<KeyGetResponse> {}
+
 export interface Keys {
   /**
    * Identifier
@@ -72,20 +74,16 @@ export interface Keys {
 
 export type KeyDeleteResponse = string;
 
-export type KeyGetResponse = Array<KeyGetResponse.KeyGetResponseItem>;
-
-export namespace KeyGetResponse {
-  export interface KeyGetResponseItem {
-    /**
-     * Identifier
-     */
-    id?: string;
+export interface KeyGetResponse {
+  /**
+   * Identifier
+   */
+  id?: string;
 
-    /**
-     * The date and time a signing key was created.
-     */
-    created?: string;
-  }
+  /**
+   * The date and time a signing key was created.
+   */
+  created?: string;
 }
 
 export interface KeyCreateParams {
@@ -114,11 +112,14 @@ export interface KeyGetParams {
   account_id: string;
 }
 
+Keys.KeyGetResponsesSinglePage = KeyGetResponsesSinglePage;
+
 export declare namespace Keys {
   export {
     type Keys as Keys,
     type KeyDeleteResponse as KeyDeleteResponse,
     type KeyGetResponse as KeyGetResponse,
+    KeyGetResponsesSinglePage as KeyGetResponsesSinglePage,
     type KeyCreateParams as KeyCreateParams,
     type KeyDeleteParams as KeyDeleteParams,
     type KeyGetParams as KeyGetParams,