cloudflare 4.4.0 → 4.5.0

package/src/resources/brand-protection.ts

@@ -1,249 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
-
-export class BrandProtection extends APIResource {
-  /**
-   * Submit suspicious URL for scanning.
-   *
-   * @example
-   * ```ts
-   * const submit = await client.brandProtection.submit({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
-   * ```
-   */
-  submit(params: BrandProtectionSubmitParams, options?: Core.RequestOptions): Core.APIPromise<Submit> {
-    const { account_id, ...body } = params;
-    return (
-      this._client.post(`/accounts/${account_id}/brand-protection/submit`, {
-        body,
-        ...options,
-      }) as Core.APIPromise<{ result: Submit }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-
-  /**
-   * Gets phishing details about a URL.
-   *
-   * @example
-   * ```ts
-   * const info = await client.brandProtection.urlInfo({
-   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
-   * });
-   * ```
-   */
-  urlInfo(params: BrandProtectionURLInfoParams, options?: Core.RequestOptions): Core.APIPromise<Info> {
-    const { account_id, ...query } = params;
-    return (
-      this._client.get(`/accounts/${account_id}/brand-protection/url-info`, {
-        query,
-        ...options,
-      }) as Core.APIPromise<{ result: Info }>
-    )._thenUnwrap((obj) => obj.result);
-  }
-}
-
-export interface Info {
-  /**
-   * List of categorizations applied to this submission.
-   */
-  categorizations?: Array<Info.Categorization>;
-
-  /**
-   * List of model results for completed scans.
-   */
-  model_results?: Array<URLInfoModelResults>;
-
-  /**
-   * List of signatures that matched against site content found when crawling the
-   * URL.
-   */
-  rule_matches?: Array<RuleMatch>;
-
-  /**
-   * Status of the most recent scan found.
-   */
-  scan_status?: ScanStatus;
-
-  /**
-   * For internal use.
-   */
-  screenshot_download_signature?: string;
-
-  /**
-   * For internal use.
-   */
-  screenshot_path?: string;
-
-  /**
-   * URL that was submitted.
-   */
-  url?: string;
-}
-
-export namespace Info {
-  export interface Categorization {
-    /**
-     * Name of the category applied.
-     */
-    category?: string;
-
-    /**
-     * Result of human review for this categorization.
-     */
-    verification_status?: string;
-  }
-}
-
-export interface RuleMatch {
-  /**
-   * For internal use.
-   */
-  banning?: boolean;
-
-  /**
-   * For internal use.
-   */
-  blocking?: boolean;
-
-  /**
-   * Description of the signature that matched.
-   */
-  description?: string;
-
-  /**
-   * Name of the signature that matched.
-   */
-  name?: string;
-}
-
-/**
- * Status of the most recent scan found.
- */
-export interface ScanStatus {
-  /**
-   * Timestamp of when the submission was processed.
-   */
-  last_processed?: string;
-
-  /**
-   * For internal use.
-   */
-  scan_complete?: boolean;
-
-  /**
-   * Status code that the crawler received when loading the submitted URL.
-   */
-  status_code?: number;
-
-  /**
-   * ID of the most recent submission.
-   */
-  submission_id?: number;
-}
-
-export interface Submit {
-  /**
-   * URLs that were excluded from scanning because their domain is in our no-scan
-   * list.
-   */
-  excluded_urls?: Array<Submit.ExcludedURL>;
-
-  /**
-   * URLs that were skipped because the same URL is currently being scanned.
-   */
-  skipped_urls?: Array<Submit.SkippedURL>;
-
-  /**
-   * URLs that were successfully submitted for scanning.
-   */
-  submitted_urls?: Array<Submit.SubmittedURL>;
-}
-
-export namespace Submit {
-  export interface ExcludedURL {
-    /**
-     * URL that was excluded.
-     */
-    url?: string;
-  }
-
-  export interface SkippedURL {
-    /**
-     * URL that was skipped.
-     */
-    url?: string;
-
-    /**
-     * ID of the submission of that URL that is currently scanning.
-     */
-    url_id?: number;
-  }
-
-  export interface SubmittedURL {
-    /**
-     * URL that was submitted.
-     */
-    url?: string;
-
-    /**
-     * ID assigned to this URL submission. Used to retrieve scanning results.
-     */
-    url_id?: number;
-  }
-}
-
-export interface URLInfoModelResults {
-  /**
-   * Name of the model.
-   */
-  model_name?: string;
-
-  /**
-   * This is the score that is outputted by the model for this submission.
-   */
-  model_score?: number;
-}
-
-export interface BrandProtectionSubmitParams {
-  /**
-   * Path param: Identifier.
-   */
-  account_id: string;
-
-  /**
-   * Body param: URL(s) to filter submissions results by.
-   */
-  url?: string;
-}
-
-export interface BrandProtectionURLInfoParams {
-  /**
-   * Path param: Identifier.
-   */
-  account_id: string;
-
-  /**
-   * Query param: Submission URL(s) to filter submission results by.
-   */
-  url?: Array<string>;
-
-  /**
-   * Query param: Submission ID(s) to filter submission results by.
-   */
-  url_id?: Array<number>;
-}
-
-export declare namespace BrandProtection {
-  export {
-    type Info as Info,
-    type RuleMatch as RuleMatch,
-    type ScanStatus as ScanStatus,
-    type Submit as Submit,
-    type URLInfoModelResults as URLInfoModelResults,
-    type BrandProtectionSubmitParams as BrandProtectionSubmitParams,
-    type BrandProtectionURLInfoParams as BrandProtectionURLInfoParams,
-  };
-}
+export * from './brand-protection/index';

package/src/resources/browser-rendering/content.ts

@@ -151,7 +151,7 @@ export interface ContentCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/json.ts

@@ -20,7 +20,7 @@ export class Json extends APIResource {
   }
 }
 
-export type JsonCreateResponse = Record<string, unknown>;
+export type JsonCreateResponse = { [key: string]: unknown };
 
 export interface JsonCreateParams {
   /**
@@ -158,7 +158,7 @@ export interface JsonCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:
@@ -273,7 +273,7 @@ export namespace JsonCreateParams {
      * Schema for the response format. More information here:
      * https://developers.cloudflare.com/workers-ai/json-mode/
      */
-    schema?: Record<string, unknown>;
+    schema?: { [key: string]: unknown };
   }
 
   /**

package/src/resources/browser-rendering/links.ts

@@ -147,7 +147,7 @@ export interface LinkCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/markdown.ts

@@ -154,7 +154,7 @@ export interface MarkdownCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/pdf.ts

@@ -113,6 +113,11 @@ export interface PDFCreateParams {
    */
   html?: string;
 
+  /**
+   * Body param: Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
+   */
+  pdfOptions?: PDFCreateParams.PDFOptions;
+
   /**
    * Body param: Block undesired requests that match the provided regex patterns, eg.
    * '/^.\*\.(css)'.
@@ -147,7 +152,7 @@ export interface PDFCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:
@@ -255,6 +260,106 @@ export namespace PDFCreateParams {
       | Array<'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'>;
   }
 
+  /**
+   * Check [options](https://pptr.dev/api/puppeteer.pdfoptions).
+   */
+  export interface PDFOptions {
+    /**
+     * Whether to show the header and footer.
+     */
+    displayHeaderFooter?: boolean;
+
+    /**
+     * HTML template for the print footer.
+     */
+    footerTemplate?: string;
+
+    /**
+     * Paper format. Takes priority over width and height if set.
+     */
+    format?: 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+
+    /**
+     * HTML template for the print header.
+     */
+    headerTemplate?: string;
+
+    /**
+     * Sets the height of paper. Can be a number or string with unit.
+     */
+    height?: string | number;
+
+    /**
+     * Whether to print in landscape orientation.
+     */
+    landscape?: boolean;
+
+    /**
+     * Set the PDF margins. Useful when setting header and footer.
+     */
+    margin?: PDFOptions.Margin;
+
+    /**
+     * Hides default white background and allows generating pdfs with transparency.
+     */
+    omitBackground?: boolean;
+
+    /**
+     * Generate document outline.
+     */
+    outline?: boolean;
+
+    /**
+     * Paper ranges to print, e.g. '1-5, 8, 11-13'.
+     */
+    pageRanges?: string;
+
+    /**
+     * Give CSS @page size priority over other size declarations.
+     */
+    preferCSSPageSize?: boolean;
+
+    /**
+     * Set to true to print background graphics.
+     */
+    printBackground?: boolean;
+
+    /**
+     * Scales the rendering of the web page. Amount must be between 0.1 and 2.
+     */
+    scale?: number;
+
+    /**
+     * Generate tagged (accessible) PDF.
+     */
+    tagged?: boolean;
+
+    /**
+     * Timeout in milliseconds.
+     */
+    timeout?: number;
+
+    /**
+     * Sets the width of paper. Can be a number or string with unit.
+     */
+    width?: string | number;
+  }
+
+  export namespace PDFOptions {
+    /**
+     * Set the PDF margins. Useful when setting header and footer.
+     */
+    export interface Margin {
+      bottom?: string | number;
+
+      left?: string | number;
+
+      right?: string | number;
+
+      top?: string | number;
+    }
+  }
+
   /**
    * Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
    */

package/src/resources/browser-rendering/scrape.ts

@@ -213,7 +213,7 @@ export interface ScrapeCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/screenshot.ts

@@ -186,7 +186,7 @@ export interface ScreenshotCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/browser-rendering/snapshot.ts

@@ -167,7 +167,7 @@ export interface SnapshotCreateParams {
   /**
    * Body param:
    */
-  setExtraHTTPHeaders?: Record<string, string>;
+  setExtraHTTPHeaders?: { [key: string]: string };
 
   /**
    * Body param:

package/src/resources/cache/cache.ts

@@ -235,7 +235,7 @@ export declare namespace CachePurgeParams {
 
   export namespace CachePurgeSingleFileWithURLAndHeaders {
     export interface File {
-      headers?: Record<string, string>;
+      headers?: { [key: string]: string };
 
       url?: string;
     }

package/src/resources/cloudforce-one/threat-events/threat-events.ts

@@ -94,8 +94,6 @@ export class ThreatEvents extends APIResource {
    * const threatEvent =
    *   await client.cloudforceOne.threatEvents.create({
    *     account_id: 'account_id',
-   *     attacker: 'Flying Yeti',
-   *     attackerCountry: 'CN',
    *     category: 'Domain Resolution',
    *     date: '2022-04-01T00:00:00Z',
    *     event: 'An attacker registered the domain domain.com',
@@ -172,8 +170,6 @@ export class ThreatEvents extends APIResource {
    *     account_id: 'account_id',
    *     data: [
    *       {
-   *         attacker: 'Flying Yeti',
-   *         attackerCountry: 'CN',
    *         category: 'Domain Resolution',
    *         date: '2022-04-01T00:00:00Z',
    *         event:
@@ -253,8 +249,6 @@ export interface ThreatEventCreateResponse {
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
@@ -312,8 +306,6 @@ export namespace ThreatEventListResponse {
 
     category: string;
 
-    categoryId: number;
-
     date: string;
 
     event: string;
@@ -362,66 +354,10 @@ export interface ThreatEventDeleteResponse {
   uuid: string;
 }
 
-export type ThreatEventBulkCreateResponse =
-  Array<ThreatEventBulkCreateResponse.ThreatEventBulkCreateResponseItem>;
-
-export namespace ThreatEventBulkCreateResponse {
-  export interface ThreatEventBulkCreateResponseItem {
-    id: number;
-
-    accountId: number;
-
-    attacker: string;
-
-    attackerCountry: string;
-
-    category: string;
-
-    categoryId: number;
-
-    date: string;
-
-    event: string;
-
-    indicator: string;
-
-    indicatorType: string;
-
-    indicatorTypeId: number;
-
-    killChain: number;
-
-    mitreAttack: Array<string>;
-
-    numReferenced: number;
-
-    numReferences: number;
-
-    rawId: string;
-
-    referenced: Array<string>;
-
-    referencedIds: Array<number>;
-
-    references: Array<string>;
-
-    referencesIds: Array<number>;
-
-    tags: Array<string>;
-
-    targetCountry: string;
-
-    targetIndustry: string;
-
-    tlp: string;
-
-    uuid: string;
-
-    insight?: string;
-
-    releasabilityId?: string;
-  }
-}
+/**
+ * Number of created bulk events
+ */
+export type ThreatEventBulkCreateResponse = number;
 
 export interface ThreatEventEditResponse {
   id: number;
@@ -434,8 +370,6 @@ export interface ThreatEventEditResponse {
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
@@ -490,8 +424,6 @@ export interface ThreatEventGetResponse {
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
@@ -544,47 +476,47 @@ export interface ThreatEventCreateParams {
   /**
    * Body param:
    */
-  attacker: string;
+  category: string;
 
   /**
    * Body param:
    */
-  attackerCountry: string;
+  date: string;
 
   /**
    * Body param:
    */
-  category: string;
+  event: string;
 
   /**
    * Body param:
    */
-  date: string;
+  indicatorType: string;
 
   /**
    * Body param:
    */
-  event: string;
+  raw: ThreatEventCreateParams.Raw;
 
   /**
    * Body param:
    */
-  indicatorType: string;
+  tlp: string;
 
   /**
    * Body param:
    */
-  raw: ThreatEventCreateParams.Raw;
+  accountId?: number;
 
   /**
    * Body param:
    */
-  tlp: string;
+  attacker?: string;
 
   /**
    * Body param:
    */
-  accountId?: number;
+  attackerCountry?: string;
 
   /**
    * Body param:
@@ -614,7 +546,7 @@ export interface ThreatEventCreateParams {
 
 export namespace ThreatEventCreateParams {
   export interface Raw {
-    data: Record<string, unknown> | null;
+    data: { [key: string]: unknown } | null;
 
     source?: string;
 
@@ -712,10 +644,6 @@ export interface ThreatEventBulkCreateParams {
 
 export namespace ThreatEventBulkCreateParams {
   export interface Data {
-    attacker: string;
-
-    attackerCountry: string;
-
     category: string;
 
     date: string;
@@ -730,6 +658,10 @@ export namespace ThreatEventBulkCreateParams {
 
     accountId?: number;
 
+    attacker?: string;
+
+    attackerCountry?: string;
+
     datasetId?: string;
 
     indicator?: string;
@@ -743,7 +675,7 @@ export namespace ThreatEventBulkCreateParams {
 
   export namespace Data {
     export interface Raw {
-      data: Record<string, unknown> | null;
+      data: { [key: string]: unknown } | null;
 
       source?: string;
 

package/src/resources/custom-hostnames/certificate-pack/certificates.ts

@@ -99,7 +99,7 @@ export interface CertificateUpdateResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME