Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): OpenAPI spec update via Stainless API #742

Merged
merged 1 commit into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -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
9 changes: 6 additions & 3 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2730,13 +2730,14 @@ Types:
- <code><a href="./src/resources/rulesets/rulesets.ts">Ruleset</a></code>
- <code><a href="./src/resources/rulesets/rulesets.ts">RulesetCreateResponse</a></code>
- <code><a href="./src/resources/rulesets/rulesets.ts">RulesetUpdateResponse</a></code>
- <code><a href="./src/resources/rulesets/rulesets.ts">RulesetListResponse</a></code>
- <code><a href="./src/resources/rulesets/rulesets.ts">RulesetGetResponse</a></code>

Methods:

- <code title="post /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">create</a>({ ...params }) -> RulesetCreateResponse</code>
- <code title="put /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">update</a>(rulesetId, { ...params }) -> RulesetUpdateResponse</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">list</a>({ ...params }) -> RulesetsSinglePage</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">list</a>({ ...params }) -> RulesetListResponsesSinglePage</code>
- <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">delete</a>(rulesetId, { ...params }) -> void</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/resources/rulesets/rulesets.ts">get</a>(rulesetId, { ...params }) -> RulesetGetResponse</code>

Expand All @@ -2756,11 +2757,12 @@ Methods:

Types:

- <code><a href="./src/resources/rulesets/phases/versions.ts">VersionListResponse</a></code>
- <code><a href="./src/resources/rulesets/phases/versions.ts">VersionGetResponse</a></code>

Methods:

- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions">client.rulesets.phases.versions.<a href="./src/resources/rulesets/phases/versions.ts">list</a>(rulesetPhase, { ...params }) -> RulesetsSinglePage</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions">client.rulesets.phases.versions.<a href="./src/resources/rulesets/phases/versions.ts">list</a>(rulesetPhase, { ...params }) -> VersionListResponsesSinglePage</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}">client.rulesets.phases.versions.<a href="./src/resources/rulesets/phases/versions.ts">get</a>(rulesetPhase, rulesetVersion, { ...params }) -> VersionGetResponse</code>

## Rules
Expand Down Expand Up @@ -2799,11 +2801,12 @@ Methods:

Types:

- <code><a href="./src/resources/rulesets/versions/versions.ts">VersionListResponse</a></code>
- <code><a href="./src/resources/rulesets/versions/versions.ts">VersionGetResponse</a></code>

Methods:

- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">list</a>(rulesetId, { ...params }) -> RulesetsSinglePage</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">list</a>(rulesetId, { ...params }) -> VersionListResponsesSinglePage</code>
- <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">delete</a>(rulesetId, rulesetVersion, { ...params }) -> void</code>
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/resources/rulesets/versions/versions.ts">get</a>(rulesetId, rulesetVersion, { ...params }) -> VersionGetResponse</code>

Expand Down
2 changes: 2 additions & 0 deletions src/resources/rulesets/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,11 @@ export {
} from './phases/index';
export { Rulesets } from './rulesets';
export {
VersionListResponse,
VersionGetResponse,
VersionListParams,
VersionDeleteParams,
VersionGetParams,
VersionListResponsesSinglePage,
Versions,
} from './versions/index';
9 changes: 8 additions & 1 deletion src/resources/rulesets/phases/index.ts
Original file line number Diff line number Diff line change
@@ -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';
7 changes: 2 additions & 5 deletions src/resources/rulesets/phases/phases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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;
}
56 changes: 49 additions & 7 deletions src/resources/rulesets/phases/versions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand All @@ -17,16 +17,16 @@ export class Versions extends APIResource {
rulesetPhase: RulesetsAPI.PhaseParam,
params?: VersionListParams,
options?: Core.RequestOptions,
): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset>;
): Core.PagePromise<VersionListResponsesSinglePage, VersionListResponse>;
list(
rulesetPhase: RulesetsAPI.PhaseParam,
options?: Core.RequestOptions,
): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset>;
): Core.PagePromise<VersionListResponsesSinglePage, VersionListResponse>;
list(
rulesetPhase: RulesetsAPI.PhaseParam,
params: VersionListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<RulesetsSinglePage, RulesetsAPI.Ruleset> {
): Core.PagePromise<VersionListResponsesSinglePage, VersionListResponse> {
if (isRequestOptions(params)) {
return this.list(rulesetPhase, {}, params);
}
Expand All @@ -49,7 +49,7 @@ export class Versions extends APIResource {
};
return this._client.getAPIList(
`/${accountOrZone}/${accountOrZoneId}/rulesets/phases/${rulesetPhase}/entrypoint/versions`,
RulesetsSinglePage,
VersionListResponsesSinglePage,
options,
);
}
Expand Down Expand Up @@ -103,6 +103,48 @@ export class Versions extends APIResource {
}
}

export class VersionListResponsesSinglePage extends SinglePage<VersionListResponse> {}

/**
* 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.
*/
Expand Down Expand Up @@ -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 };
57 changes: 47 additions & 10 deletions src/resources/rulesets/rulesets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,12 @@ export class Rulesets extends APIResource {
list(
params?: RulesetListParams,
options?: Core.RequestOptions,
): Core.PagePromise<RulesetsSinglePage, Ruleset>;
list(options?: Core.RequestOptions): Core.PagePromise<RulesetsSinglePage, Ruleset>;
): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse>;
list(options?: Core.RequestOptions): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse>;
list(
params: RulesetListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<RulesetsSinglePage, Ruleset> {
): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse> {
if (isRequestOptions(params)) {
return this.list({}, params);
}
Expand All @@ -110,7 +110,7 @@ export class Rulesets extends APIResource {
};
return this._client.getAPIList(
`/${accountOrZone}/${accountOrZoneId}/rulesets`,
RulesetsSinglePage,
RulesetListResponsesSinglePage,
options,
);
}
Expand Down Expand Up @@ -198,7 +198,7 @@ export class Rulesets extends APIResource {
}
}

export class RulesetsSinglePage extends SinglePage<Ruleset> {}
export class RulesetListResponsesSinglePage extends SinglePage<RulesetListResponse> {}

/**
* The kind of the ruleset.
Expand Down Expand Up @@ -290,11 +290,6 @@ export interface Ruleset {
*/
description?: string;

/**
* The kind of the ruleset.
*/
kind?: Kind;

/**
* The human-readable name of the ruleset.
*/
Expand Down Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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;
Expand Down
2 changes: 2 additions & 0 deletions src/resources/rulesets/versions/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

export { ByTagGetResponse, ByTagGetParams, ByTag } from './by-tag';
export {
VersionListResponse,
VersionGetResponse,
VersionListParams,
VersionDeleteParams,
VersionGetParams,
VersionListResponsesSinglePage,
Versions,
} from './versions';
Loading