From 787aa308c9805c8cc47fbf2c842ec6a3f7b53c12 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 4 Jun 2024 08:59:56 +0000 Subject: [PATCH] feat(api): OpenAPI spec update via Stainless API (#742) --- .stats.yml | 2 +- api.md | 9 ++- src/resources/rulesets/index.ts | 2 + src/resources/rulesets/phases/index.ts | 9 ++- src/resources/rulesets/phases/phases.ts | 7 +-- src/resources/rulesets/phases/versions.ts | 56 +++++++++++++++--- src/resources/rulesets/rulesets.ts | 57 +++++++++++++++---- src/resources/rulesets/versions/index.ts | 2 + src/resources/rulesets/versions/versions.ts | 56 +++++++++++++++--- .../rulesets/phases/phases.test.ts | 1 - 10 files changed, 166 insertions(+), 35 deletions(-) diff --git a/.stats.yml b/.stats.yml index 036bd6a320..4d1193a3b2 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 1335 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-e83b5eb5706ca8b525141f506338cd1d465eb133815b9ddc53df612ea4a2ecef.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-0be7a22d1cc24a2a63cf7c7d9324fa078990d35e80629e2cbd28b9838940d75d.yml diff --git a/api.md b/api.md index c63d989b54..e6ea0dc39b 100644 --- a/api.md +++ b/api.md @@ -2730,13 +2730,14 @@ Types: - Ruleset - RulesetCreateResponse - RulesetUpdateResponse +- RulesetListResponse - RulesetGetResponse Methods: - client.rulesets.create({ ...params }) -> RulesetCreateResponse - client.rulesets.update(rulesetId, { ...params }) -> RulesetUpdateResponse -- client.rulesets.list({ ...params }) -> RulesetsSinglePage +- client.rulesets.list({ ...params }) -> RulesetListResponsesSinglePage - client.rulesets.delete(rulesetId, { ...params }) -> void - client.rulesets.get(rulesetId, { ...params }) -> RulesetGetResponse @@ -2756,11 +2757,12 @@ Methods: Types: +- VersionListResponse - VersionGetResponse Methods: -- client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> RulesetsSinglePage +- client.rulesets.phases.versions.list(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage - client.rulesets.phases.versions.get(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse ## Rules @@ -2799,11 +2801,12 @@ Methods: Types: +- VersionListResponse - VersionGetResponse Methods: -- client.rulesets.versions.list(rulesetId, { ...params }) -> RulesetsSinglePage +- client.rulesets.versions.list(rulesetId, { ...params }) -> VersionListResponsesSinglePage - client.rulesets.versions.delete(rulesetId, rulesetVersion, { ...params }) -> void - client.rulesets.versions.get(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse diff --git a/src/resources/rulesets/index.ts b/src/resources/rulesets/index.ts index 4c6a8f453c..1422ae1008 100644 --- a/src/resources/rulesets/index.ts +++ b/src/resources/rulesets/index.ts @@ -36,9 +36,11 @@ export { } from './phases/index'; export { Rulesets } from './rulesets'; export { + VersionListResponse, VersionGetResponse, VersionListParams, VersionDeleteParams, VersionGetParams, + VersionListResponsesSinglePage, Versions, } from './versions/index'; diff --git a/src/resources/rulesets/phases/index.ts b/src/resources/rulesets/phases/index.ts index d93a45f21f..048dff1de6 100644 --- a/src/resources/rulesets/phases/index.ts +++ b/src/resources/rulesets/phases/index.ts @@ -1,4 +1,11 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. export { PhaseUpdateResponse, PhaseGetResponse, PhaseUpdateParams, PhaseGetParams, Phases } from './phases'; -export { VersionGetResponse, VersionListParams, VersionGetParams, Versions } from './versions'; +export { + VersionListResponse, + VersionGetResponse, + VersionListParams, + VersionGetParams, + VersionListResponsesSinglePage, + Versions, +} from './versions'; diff --git a/src/resources/rulesets/phases/phases.ts b/src/resources/rulesets/phases/phases.ts index 3f7651f973..6d5af19145 100644 --- a/src/resources/rulesets/phases/phases.ts +++ b/src/resources/rulesets/phases/phases.ts @@ -713,11 +713,6 @@ export interface PhaseUpdateParams { */ description?: string; - /** - * Body param: The kind of the ruleset. - */ - kind?: RulesetsAPI.KindParam; - /** * Body param: The human-readable name of the ruleset. */ @@ -929,7 +924,9 @@ export namespace Phases { export import PhaseUpdateParams = PhasesAPI.PhaseUpdateParams; export import PhaseGetParams = PhasesAPI.PhaseGetParams; export import Versions = VersionsAPI.Versions; + export import VersionListResponse = VersionsAPI.VersionListResponse; export import VersionGetResponse = VersionsAPI.VersionGetResponse; + export import VersionListResponsesSinglePage = VersionsAPI.VersionListResponsesSinglePage; export import VersionListParams = VersionsAPI.VersionListParams; export import VersionGetParams = VersionsAPI.VersionGetParams; } diff --git a/src/resources/rulesets/phases/versions.ts b/src/resources/rulesets/phases/versions.ts index 541d289ebb..fa312b84fe 100644 --- a/src/resources/rulesets/phases/versions.ts +++ b/src/resources/rulesets/phases/versions.ts @@ -7,7 +7,7 @@ import { CloudflareError } from '../../../error'; import * as VersionsAPI from './versions'; import * as RulesAPI from '../rules'; import * as RulesetsAPI from '../rulesets'; -import { RulesetsSinglePage } from '../rulesets'; +import { SinglePage } from '../../../pagination'; export class Versions extends APIResource { /** @@ -17,16 +17,16 @@ export class Versions extends APIResource { rulesetPhase: RulesetsAPI.PhaseParam, params?: VersionListParams, options?: Core.RequestOptions, - ): Core.PagePromise; + ): Core.PagePromise; list( rulesetPhase: RulesetsAPI.PhaseParam, options?: Core.RequestOptions, - ): Core.PagePromise; + ): Core.PagePromise; list( rulesetPhase: RulesetsAPI.PhaseParam, params: VersionListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { if (isRequestOptions(params)) { return this.list(rulesetPhase, {}, params); } @@ -49,7 +49,7 @@ export class Versions extends APIResource { }; return this._client.getAPIList( `/${accountOrZone}/${accountOrZoneId}/rulesets/phases/${rulesetPhase}/entrypoint/versions`, - RulesetsSinglePage, + VersionListResponsesSinglePage, options, ); } @@ -103,6 +103,48 @@ export class Versions extends APIResource { } } +export class VersionListResponsesSinglePage extends SinglePage {} + +/** + * A ruleset object. + */ +export interface VersionListResponse { + /** + * The unique ID of the ruleset. + */ + id: string; + + /** + * The kind of the ruleset. + */ + kind: RulesetsAPI.Kind; + + /** + * The timestamp of when the ruleset was last modified. + */ + last_updated: string; + + /** + * The human-readable name of the ruleset. + */ + name: string; + + /** + * The phase of the ruleset. + */ + phase: RulesetsAPI.Phase; + + /** + * The version of the ruleset. + */ + version: string; + + /** + * An informative description of the ruleset. + */ + description?: string; +} + /** * A ruleset object. */ @@ -419,9 +461,9 @@ export interface VersionGetParams { } export namespace Versions { + export import VersionListResponse = VersionsAPI.VersionListResponse; export import VersionGetResponse = VersionsAPI.VersionGetResponse; + export import VersionListResponsesSinglePage = VersionsAPI.VersionListResponsesSinglePage; export import VersionListParams = VersionsAPI.VersionListParams; export import VersionGetParams = VersionsAPI.VersionGetParams; } - -export { RulesetsSinglePage }; diff --git a/src/resources/rulesets/rulesets.ts b/src/resources/rulesets/rulesets.ts index e50d1052ed..5b91cb15f2 100644 --- a/src/resources/rulesets/rulesets.ts +++ b/src/resources/rulesets/rulesets.ts @@ -82,12 +82,12 @@ export class Rulesets extends APIResource { list( params?: RulesetListParams, options?: Core.RequestOptions, - ): Core.PagePromise; - list(options?: Core.RequestOptions): Core.PagePromise; + ): Core.PagePromise; + list(options?: Core.RequestOptions): Core.PagePromise; list( params: RulesetListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { if (isRequestOptions(params)) { return this.list({}, params); } @@ -110,7 +110,7 @@ export class Rulesets extends APIResource { }; return this._client.getAPIList( `/${accountOrZone}/${accountOrZoneId}/rulesets`, - RulesetsSinglePage, + RulesetListResponsesSinglePage, options, ); } @@ -198,7 +198,7 @@ export class Rulesets extends APIResource { } } -export class RulesetsSinglePage extends SinglePage {} +export class RulesetListResponsesSinglePage extends SinglePage {} /** * The kind of the ruleset. @@ -290,11 +290,6 @@ export interface Ruleset { */ description?: string; - /** - * The kind of the ruleset. - */ - kind?: Kind; - /** * The human-readable name of the ruleset. */ @@ -888,6 +883,46 @@ export namespace RulesetUpdateResponse { } } +/** + * A ruleset object. + */ +export interface RulesetListResponse { + /** + * The unique ID of the ruleset. + */ + id: string; + + /** + * The kind of the ruleset. + */ + kind: Kind; + + /** + * The timestamp of when the ruleset was last modified. + */ + last_updated: string; + + /** + * The human-readable name of the ruleset. + */ + name: string; + + /** + * The phase of the ruleset. + */ + phase: Phase; + + /** + * The version of the ruleset. + */ + version: string; + + /** + * An informative description of the ruleset. + */ + description?: string; +} + /** * A ruleset object. */ @@ -1727,7 +1762,9 @@ export namespace Rulesets { export import RuleDeleteParams = RulesAPI.RuleDeleteParams; export import RuleEditParams = RulesAPI.RuleEditParams; export import Versions = VersionsAPI.Versions; + export import VersionListResponse = VersionsAPI.VersionListResponse; export import VersionGetResponse = VersionsAPI.VersionGetResponse; + export import VersionListResponsesSinglePage = VersionsAPI.VersionListResponsesSinglePage; export import VersionListParams = VersionsAPI.VersionListParams; export import VersionDeleteParams = VersionsAPI.VersionDeleteParams; export import VersionGetParams = VersionsAPI.VersionGetParams; diff --git a/src/resources/rulesets/versions/index.ts b/src/resources/rulesets/versions/index.ts index 698f3efbd1..b5ad4ccbba 100644 --- a/src/resources/rulesets/versions/index.ts +++ b/src/resources/rulesets/versions/index.ts @@ -2,9 +2,11 @@ export { ByTagGetResponse, ByTagGetParams, ByTag } from './by-tag'; export { + VersionListResponse, VersionGetResponse, VersionListParams, VersionDeleteParams, VersionGetParams, + VersionListResponsesSinglePage, Versions, } from './versions'; diff --git a/src/resources/rulesets/versions/versions.ts b/src/resources/rulesets/versions/versions.ts index c831e38ef7..25243265ca 100644 --- a/src/resources/rulesets/versions/versions.ts +++ b/src/resources/rulesets/versions/versions.ts @@ -7,8 +7,8 @@ import { CloudflareError } from '../../../error'; import * as VersionsAPI from './versions'; import * as RulesAPI from '../rules'; import * as RulesetsAPI from '../rulesets'; -import { RulesetsSinglePage } from '../rulesets'; import * as ByTagAPI from './by-tag'; +import { SinglePage } from '../../../pagination'; export class Versions extends APIResource { byTag: ByTagAPI.ByTag = new ByTagAPI.ByTag(this._client); @@ -20,16 +20,16 @@ export class Versions extends APIResource { rulesetId: string, params?: VersionListParams, options?: Core.RequestOptions, - ): Core.PagePromise; + ): Core.PagePromise; list( rulesetId: string, options?: Core.RequestOptions, - ): Core.PagePromise; + ): Core.PagePromise; list( rulesetId: string, params: VersionListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, - ): Core.PagePromise { + ): Core.PagePromise { if (isRequestOptions(params)) { return this.list(rulesetId, {}, params); } @@ -52,7 +52,7 @@ export class Versions extends APIResource { }; return this._client.getAPIList( `/${accountOrZone}/${accountOrZoneId}/rulesets/${rulesetId}/versions`, - RulesetsSinglePage, + VersionListResponsesSinglePage, options, ); } @@ -148,6 +148,48 @@ export class Versions extends APIResource { } } +export class VersionListResponsesSinglePage extends SinglePage {} + +/** + * A ruleset object. + */ +export interface VersionListResponse { + /** + * The unique ID of the ruleset. + */ + id: string; + + /** + * The kind of the ruleset. + */ + kind: RulesetsAPI.Kind; + + /** + * The timestamp of when the ruleset was last modified. + */ + last_updated: string; + + /** + * The human-readable name of the ruleset. + */ + name: string; + + /** + * The phase of the ruleset. + */ + phase: RulesetsAPI.Phase; + + /** + * The version of the ruleset. + */ + version: string; + + /** + * An informative description of the ruleset. + */ + description?: string; +} + /** * A ruleset object. */ @@ -476,7 +518,9 @@ export interface VersionGetParams { } export namespace Versions { + export import VersionListResponse = VersionsAPI.VersionListResponse; export import VersionGetResponse = VersionsAPI.VersionGetResponse; + export import VersionListResponsesSinglePage = VersionsAPI.VersionListResponsesSinglePage; export import VersionListParams = VersionsAPI.VersionListParams; export import VersionDeleteParams = VersionsAPI.VersionDeleteParams; export import VersionGetParams = VersionsAPI.VersionGetParams; @@ -484,5 +528,3 @@ export namespace Versions { export import ByTagGetResponse = ByTagAPI.ByTagGetResponse; export import ByTagGetParams = ByTagAPI.ByTagGetParams; } - -export { RulesetsSinglePage }; diff --git a/tests/api-resources/rulesets/phases/phases.test.ts b/tests/api-resources/rulesets/phases/phases.test.ts index 9573b9b583..9b0485aa85 100644 --- a/tests/api-resources/rulesets/phases/phases.test.ts +++ b/tests/api-resources/rulesets/phases/phases.test.ts @@ -80,7 +80,6 @@ describe('resource phases', () => { ], account_id: 'string', description: 'My ruleset to execute managed rulesets', - kind: 'root', name: 'My ruleset', phase: 'http_request_firewall_custom', });