From 7609e84ab3db53e79aefce6a112e90cb2a2bbba0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 20 Feb 2024 20:01:41 +0000 Subject: [PATCH] feat: OpenAPI spec update via Stainless API (#40) --- .stats.yml | 2 +- api.md | 8 --- src/index.ts | 2 - src/resources/cache/cache.ts | 84 ------------------------- src/resources/cache/index.ts | 2 +- src/resources/index.ts | 2 +- src/resources/pcaps/pcaps.ts | 62 +++++++++--------- tests/api-resources/cache/cache.test.ts | 26 -------- 8 files changed, 34 insertions(+), 154 deletions(-) delete mode 100644 tests/api-resources/cache/cache.test.ts diff --git a/.stats.yml b/.stats.yml index 42d2723898..961e096a51 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1 +1 @@ -configured_endpoints: 1111 +configured_endpoints: 1110 diff --git a/api.md b/api.md index 456d4cbcab..b92205c6b9 100644 --- a/api.md +++ b/api.md @@ -802,14 +802,6 @@ Methods: # Cache -Types: - -- CachePurgeResponse - -Methods: - -- client.cache.purge(identifier, { ...params }) -> CachePurgeResponse | null - ## CacheReserves Types: diff --git a/src/index.ts b/src/index.ts index 724402c792..33dff65a5e 100644 --- a/src/index.ts +++ b/src/index.ts @@ -415,8 +415,6 @@ export namespace Cloudflare { export import DNSAnalytics = API.DNSAnalytics; export import Cache = API.Cache; - export import CachePurgeResponse = API.CachePurgeResponse; - export import CachePurgeParams = API.CachePurgeParams; export import SSL = API.SSL; diff --git a/src/resources/cache/cache.ts b/src/resources/cache/cache.ts index f5b8f57e7f..789dd75fe2 100644 --- a/src/resources/cache/cache.ts +++ b/src/resources/cache/cache.ts @@ -1,8 +1,6 @@ // File generated from our OpenAPI spec by Stainless. -import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; -import * as CacheAPI from 'cloudflare/resources/cache/cache'; import * as CacheReservesAPI from 'cloudflare/resources/cache/cache-reserves'; import * as RegionalTieredCacheAPI from 'cloudflare/resources/cache/regional-tiered-cache'; import * as TieredCacheSmartTopologyAPI from 'cloudflare/resources/cache/tiered-cache-smart-topology'; @@ -15,91 +13,9 @@ export class Cache extends APIResource { variants: VariantsAPI.Variants = new VariantsAPI.Variants(this._client); regionalTieredCache: RegionalTieredCacheAPI.RegionalTieredCache = new RegionalTieredCacheAPI.RegionalTieredCache(this._client); - - /** - * ### Purge All Cached Content - * - * Removes ALL files from Cloudflare's cache. All tiers can purge everything. - * - * ### Purge Cached Content by URL - * - * Granularly removes one or more files from Cloudflare's cache by specifying URLs. - * All tiers can purge by URL. - * - * To purge files with custom cache keys, include the headers used to compute the - * cache key as in the example. If you have a device type or geo in your cache key, - * you will need to include the CF-Device-Type or CF-IPCountry headers. If you have - * lang in your cache key, you will need to include the Accept-Language header. - * - * **NB:** When including the Origin header, be sure to include the **scheme** and - * **hostname**. The port number can be omitted if it is the default port (80 for - * http, 443 for https), but must be included otherwise. - * - * ### Purge Cached Content by Tag, Host or Prefix - * - * Granularly removes one or more files from Cloudflare's cache either by - * specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise - * customers are permitted to purge by Tag, Host or Prefix. - * - * **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 - * purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or - * prefixes in one API call. This rate limit can be raised for customers who need - * to purge at higher volume. - */ - purge( - identifier: string, - body: CachePurgeParams, - options?: Core.RequestOptions, - ): Core.APIPromise { - return ( - this._client.post(`/zones/${identifier}/purge_cache`, { body, ...options }) as Core.APIPromise<{ - result: CachePurgeResponse | null; - }> - )._thenUnwrap((obj) => obj.result); - } -} - -export interface CachePurgeResponse { - /** - * Identifier - */ - id: string; -} - -export type CachePurgeParams = - | CachePurgeParams.Qepy7bYeFlex - | CachePurgeParams.Qepy7bYeEverything - | CachePurgeParams.Qepy7bYeFiles; - -export namespace CachePurgeParams { - export interface Qepy7bYeFlex { - hosts?: Array; - - prefixes?: Array; - - tags?: Array; - } - - export interface Qepy7bYeEverything { - purge_everything?: boolean; - } - - export interface Qepy7bYeFiles { - files?: Array; - } - - export namespace Qepy7bYeFiles { - export interface Qepy7bYeURLAndHeaders { - headers?: unknown; - - url?: string; - } - } } export namespace Cache { - export import CachePurgeResponse = CacheAPI.CachePurgeResponse; - export import CachePurgeParams = CacheAPI.CachePurgeParams; export import CacheReserves = CacheReservesAPI.CacheReserves; export import CacheReserveUpdateResponse = CacheReservesAPI.CacheReserveUpdateResponse; export import CacheReserveListResponse = CacheReservesAPI.CacheReserveListResponse; diff --git a/src/resources/cache/index.ts b/src/resources/cache/index.ts index 2bfde0a131..3447948bb6 100644 --- a/src/resources/cache/index.ts +++ b/src/resources/cache/index.ts @@ -1,6 +1,6 @@ // File generated from our OpenAPI spec by Stainless. -export { CachePurgeResponse, CachePurgeParams, Cache } from './cache'; +export { Cache } from './cache'; export { CacheReserveUpdateResponse, CacheReserveListResponse, diff --git a/src/resources/index.ts b/src/resources/index.ts index 3bac588d15..76f952bdde 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -45,7 +45,7 @@ export { BotManagement, } from './bot-management'; export { BrandProtection } from './brand-protection/brand-protection'; -export { CachePurgeResponse, CachePurgeParams, Cache } from './cache/cache'; +export { Cache } from './cache/cache'; export { CacheReserveCreateResponse, CacheReserveGetResponse, CacheReserve } from './cache-reserve'; export { CallCreateResponse, diff --git a/src/resources/pcaps/pcaps.ts b/src/resources/pcaps/pcaps.ts index 8e380c562b..93639e417c 100644 --- a/src/resources/pcaps/pcaps.ts +++ b/src/resources/pcaps/pcaps.ts @@ -53,11 +53,11 @@ export class Pcaps extends APIResource { } export type PcapCreateResponse = - | PcapCreateResponse.PgpenC68PcapsResponseSimple - | PcapCreateResponse.PgpenC68PcapsResponseFull; + | PcapCreateResponse.EErxb5cBPcapsResponseSimple + | PcapCreateResponse.EErxb5cBPcapsResponseFull; export namespace PcapCreateResponse { - export interface PgpenC68PcapsResponseSimple { + export interface EErxb5cBPcapsResponseSimple { /** * The ID for the packet capture. */ @@ -66,7 +66,7 @@ export namespace PcapCreateResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseSimple.FilterV1; + filter_v1?: EErxb5cBPcapsResponseSimple.FilterV1; /** * The status of the packet capture request. @@ -103,7 +103,7 @@ export namespace PcapCreateResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseSimple { + export namespace EErxb5cBPcapsResponseSimple { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -135,7 +135,7 @@ export namespace PcapCreateResponse { } } - export interface PgpenC68PcapsResponseFull { + export interface EErxb5cBPcapsResponseFull { /** * The ID for the packet capture. */ @@ -168,7 +168,7 @@ export namespace PcapCreateResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseFull.FilterV1; + filter_v1?: EErxb5cBPcapsResponseFull.FilterV1; /** * The status of the packet capture request. @@ -205,7 +205,7 @@ export namespace PcapCreateResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseFull { + export namespace EErxb5cBPcapsResponseFull { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -239,11 +239,11 @@ export namespace PcapCreateResponse { } export type PcapListResponse = Array< - PcapListResponse.PgpenC68PcapsResponseSimple | PcapListResponse.PgpenC68PcapsResponseFull + PcapListResponse.EErxb5cBPcapsResponseSimple | PcapListResponse.EErxb5cBPcapsResponseFull >; export namespace PcapListResponse { - export interface PgpenC68PcapsResponseSimple { + export interface EErxb5cBPcapsResponseSimple { /** * The ID for the packet capture. */ @@ -252,7 +252,7 @@ export namespace PcapListResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseSimple.FilterV1; + filter_v1?: EErxb5cBPcapsResponseSimple.FilterV1; /** * The status of the packet capture request. @@ -289,7 +289,7 @@ export namespace PcapListResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseSimple { + export namespace EErxb5cBPcapsResponseSimple { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -321,7 +321,7 @@ export namespace PcapListResponse { } } - export interface PgpenC68PcapsResponseFull { + export interface EErxb5cBPcapsResponseFull { /** * The ID for the packet capture. */ @@ -354,7 +354,7 @@ export namespace PcapListResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseFull.FilterV1; + filter_v1?: EErxb5cBPcapsResponseFull.FilterV1; /** * The status of the packet capture request. @@ -391,7 +391,7 @@ export namespace PcapListResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseFull { + export namespace EErxb5cBPcapsResponseFull { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -425,11 +425,11 @@ export namespace PcapListResponse { } export type PcapGetResponse = - | PcapGetResponse.PgpenC68PcapsResponseSimple - | PcapGetResponse.PgpenC68PcapsResponseFull; + | PcapGetResponse.EErxb5cBPcapsResponseSimple + | PcapGetResponse.EErxb5cBPcapsResponseFull; export namespace PcapGetResponse { - export interface PgpenC68PcapsResponseSimple { + export interface EErxb5cBPcapsResponseSimple { /** * The ID for the packet capture. */ @@ -438,7 +438,7 @@ export namespace PcapGetResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseSimple.FilterV1; + filter_v1?: EErxb5cBPcapsResponseSimple.FilterV1; /** * The status of the packet capture request. @@ -475,7 +475,7 @@ export namespace PcapGetResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseSimple { + export namespace EErxb5cBPcapsResponseSimple { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -507,7 +507,7 @@ export namespace PcapGetResponse { } } - export interface PgpenC68PcapsResponseFull { + export interface EErxb5cBPcapsResponseFull { /** * The ID for the packet capture. */ @@ -540,7 +540,7 @@ export namespace PcapGetResponse { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PgpenC68PcapsResponseFull.FilterV1; + filter_v1?: EErxb5cBPcapsResponseFull.FilterV1; /** * The status of the packet capture request. @@ -577,7 +577,7 @@ export namespace PcapGetResponse { type?: 'simple' | 'full'; } - export namespace PgpenC68PcapsResponseFull { + export namespace EErxb5cBPcapsResponseFull { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -611,11 +611,11 @@ export namespace PcapGetResponse { } export type PcapCreateParams = - | PcapCreateParams.PgpenC68PcapsRequestSimple - | PcapCreateParams.PgpenC68PcapsRequestFull; + | PcapCreateParams.EErxb5cBPcapsRequestSimple + | PcapCreateParams.EErxb5cBPcapsRequestFull; export namespace PcapCreateParams { - export interface PgpenC68PcapsRequestSimple { + export interface EErxb5cBPcapsRequestSimple { /** * The limit of packets contained in a packet capture. */ @@ -640,10 +640,10 @@ export namespace PcapCreateParams { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PcapCreateParams.PgpenC68PcapsRequestSimple.FilterV1; + filter_v1?: PcapCreateParams.EErxb5cBPcapsRequestSimple.FilterV1; } - export namespace PgpenC68PcapsRequestSimple { + export namespace EErxb5cBPcapsRequestSimple { /** * The packet capture filter. When this field is empty, all packets are captured. */ @@ -675,7 +675,7 @@ export namespace PcapCreateParams { } } - export interface PgpenC68PcapsRequestFull { + export interface EErxb5cBPcapsRequestFull { /** * The name of the data center used for the packet capture. This can be a specific * colo (ord02) or a multi-colo name (ORD). This field only applies to `full` @@ -713,7 +713,7 @@ export namespace PcapCreateParams { /** * The packet capture filter. When this field is empty, all packets are captured. */ - filter_v1?: PcapCreateParams.PgpenC68PcapsRequestFull.FilterV1; + filter_v1?: PcapCreateParams.EErxb5cBPcapsRequestFull.FilterV1; /** * The limit of packets contained in a packet capture. @@ -721,7 +721,7 @@ export namespace PcapCreateParams { packet_limit?: number; } - export namespace PgpenC68PcapsRequestFull { + export namespace EErxb5cBPcapsRequestFull { /** * The packet capture filter. When this field is empty, all packets are captured. */ diff --git a/tests/api-resources/cache/cache.test.ts b/tests/api-resources/cache/cache.test.ts deleted file mode 100644 index 828786b36b..0000000000 --- a/tests/api-resources/cache/cache.test.ts +++ /dev/null @@ -1,26 +0,0 @@ -// File generated from our OpenAPI spec by Stainless. - -import Cloudflare from 'cloudflare'; -import { Response } from 'node-fetch'; - -const cloudflare = new Cloudflare({ - apiKey: '144c9defac04969c7bfad8efaa8ea194', - apiEmail: 'dev@cloudflare.com', - apiToken: 'Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY', - userServiceKey: 'My User Service Key', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', -}); - -describe('resource cache', () => { - // skipped: tests are disabled for the time being - test.skip('purge', async () => { - const responsePromise = cloudflare.cache.purge('string', {}); - const rawResponse = await responsePromise.asResponse(); - expect(rawResponse).toBeInstanceOf(Response); - const response = await responsePromise; - expect(response).not.toBeInstanceOf(Response); - const dataAndResponse = await responsePromise.withResponse(); - expect(dataAndResponse.data).toBe(response); - expect(dataAndResponse.response).toBe(rawResponse); - }); -});