Skip to content

Commit d35bbfb

Browse files
chore(api): update composite API spec
1 parent 737f2f7 commit d35bbfb

File tree

13 files changed

+454
-379
lines changed

13 files changed

+454
-379
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1811
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-f667fe85c44838740e4df740349e1a7a4d8b29f1289263687e5515be63756c4f.yml
3-
openapi_spec_hash: 5ac65f347af852e1ac6eaff79246fc33
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-f0df9799d57279965730a3efbadfd041338e15a86cafa330e10fd03b09036fdc.yml
3+
openapi_spec_hash: 12c366fbc2a677cb9778548532ad7b3c
44
config_hash: 4e184f6d41e4088670e95ba876c8238b

api.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8471,43 +8471,37 @@ Methods:
84718471

84728472
# LeakedCredentialChecks
84738473

8474-
## Detections
8475-
8476-
# ContentScanning
8477-
84788474
Types:
84798475

8480-
- <code><a href="./src/resources/content-scanning/content-scanning.ts">ContentScanningDisableResponse</a></code>
8481-
- <code><a href="./src/resources/content-scanning/content-scanning.ts">ContentScanningEnableResponse</a></code>
8476+
- <code><a href="./src/resources/leaked-credential-checks/leaked-credential-checks.ts">LeakedCredentialCheckCreateResponse</a></code>
8477+
- <code><a href="./src/resources/leaked-credential-checks/leaked-credential-checks.ts">LeakedCredentialCheckGetResponse</a></code>
84828478

84838479
Methods:
84848480

8485-
- <code title="post /zones/{zone_id}/content-upload-scan/disable">client.contentScanning.<a href="./src/resources/content-scanning/content-scanning.ts">disable</a>({ ...params }) -> ContentScanningDisableResponse</code>
8486-
- <code title="post /zones/{zone_id}/content-upload-scan/enable">client.contentScanning.<a href="./src/resources/content-scanning/content-scanning.ts">enable</a>({ ...params }) -> ContentScanningEnableResponse</code>
8481+
- <code title="post /zones/{zone_id}/leaked-credential-checks">client.leakedCredentialChecks.<a href="./src/resources/leaked-credential-checks/leaked-credential-checks.ts">create</a>({ ...params }) -> LeakedCredentialCheckCreateResponse</code>
8482+
- <code title="get /zones/{zone_id}/leaked-credential-checks">client.leakedCredentialChecks.<a href="./src/resources/leaked-credential-checks/leaked-credential-checks.ts">get</a>({ ...params }) -> LeakedCredentialCheckGetResponse</code>
84878483

8488-
## Payloads
8484+
## Detections
84898485

84908486
Types:
84918487

8492-
- <code><a href="./src/resources/content-scanning/payloads.ts">PayloadCreateResponse</a></code>
8493-
- <code><a href="./src/resources/content-scanning/payloads.ts">PayloadListResponse</a></code>
8494-
- <code><a href="./src/resources/content-scanning/payloads.ts">PayloadDeleteResponse</a></code>
8488+
- <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionCreateResponse</a></code>
8489+
- <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionUpdateResponse</a></code>
8490+
- <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionListResponse</a></code>
8491+
- <code><a href="./src/resources/leaked-credential-checks/detections.ts">DetectionDeleteResponse</a></code>
84958492

84968493
Methods:
84978494

8498-
- <code title="post /zones/{zone_id}/content-upload-scan/payloads">client.contentScanning.payloads.<a href="./src/resources/content-scanning/payloads.ts">create</a>([ ...body ]) -> PayloadCreateResponsesSinglePage</code>
8499-
- <code title="get /zones/{zone_id}/content-upload-scan/payloads">client.contentScanning.payloads.<a href="./src/resources/content-scanning/payloads.ts">list</a>({ ...params }) -> PayloadListResponsesSinglePage</code>
8500-
- <code title="delete /zones/{zone_id}/content-upload-scan/payloads/{expression_id}">client.contentScanning.payloads.<a href="./src/resources/content-scanning/payloads.ts">delete</a>(expressionId, { ...params }) -> PayloadDeleteResponsesSinglePage</code>
8501-
8502-
## Settings
8503-
8504-
Types:
8495+
- <code title="post /zones/{zone_id}/leaked-credential-checks/detections">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">create</a>({ ...params }) -> DetectionCreateResponse</code>
8496+
- <code title="put /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">update</a>(detectionId, { ...params }) -> DetectionUpdateResponse</code>
8497+
- <code title="get /zones/{zone_id}/leaked-credential-checks/detections">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">list</a>({ ...params }) -> DetectionListResponsesSinglePage</code>
8498+
- <code title="delete /zones/{zone_id}/leaked-credential-checks/detections/{detection_id}">client.leakedCredentialChecks.detections.<a href="./src/resources/leaked-credential-checks/detections.ts">delete</a>(detectionId, { ...params }) -> DetectionDeleteResponse</code>
85058499

8506-
- <code><a href="./src/resources/content-scanning/settings.ts">SettingGetResponse</a></code>
8500+
# ContentScanning
85078501

8508-
Methods:
8502+
## Payloads
85098503

8510-
- <code title="get /zones/{zone_id}/content-upload-scan/settings">client.contentScanning.settings.<a href="./src/resources/content-scanning/settings.ts">get</a>({ ...params }) -> SettingGetResponse</code>
8504+
## Settings
85118505

85128506
# AbuseReports
85138507

scripts/detect-breaking-changes

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -716,9 +716,8 @@ TEST_PATHS=(
716716
tests/api-resources/resource-sharing/resource-sharing.test.ts
717717
tests/api-resources/resource-sharing/recipients.test.ts
718718
tests/api-resources/resource-sharing/resources.test.ts
719-
tests/api-resources/content-scanning/content-scanning.test.ts
720-
tests/api-resources/content-scanning/payloads.test.ts
721-
tests/api-resources/content-scanning/settings.test.ts
719+
tests/api-resources/leaked-credential-checks/leaked-credential-checks.test.ts
720+
tests/api-resources/leaked-credential-checks/detections.test.ts
722721
tests/api-resources/abuse-reports.test.ts
723722
tests/api-resources/ai/ai.test.ts
724723
tests/api-resources/ai/finetunes/finetunes.test.ts
Lines changed: 4 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,21 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../../resource';
4-
import * as Core from '../../core';
54
import * as PayloadsAPI from './payloads';
6-
import {
7-
PayloadCreateParams,
8-
PayloadCreateResponse,
9-
PayloadCreateResponsesSinglePage,
10-
PayloadDeleteParams,
11-
PayloadDeleteResponse,
12-
PayloadDeleteResponsesSinglePage,
13-
PayloadListParams,
14-
PayloadListResponse,
15-
PayloadListResponsesSinglePage,
16-
Payloads,
17-
} from './payloads';
5+
import { Payloads } from './payloads';
186
import * as SettingsAPI from './settings';
19-
import { SettingGetParams, SettingGetResponse, Settings } from './settings';
7+
import { Settings } from './settings';
208

219
export class ContentScanning extends APIResource {
2210
payloads: PayloadsAPI.Payloads = new PayloadsAPI.Payloads(this._client);
2311
settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
24-
25-
/**
26-
* Disable Content Scanning.
27-
*/
28-
disable(
29-
params: ContentScanningDisableParams,
30-
options?: Core.RequestOptions,
31-
): Core.APIPromise<ContentScanningDisableResponse> {
32-
const { zone_id } = params;
33-
return (
34-
this._client.post(`/zones/${zone_id}/content-upload-scan/disable`, options) as Core.APIPromise<{
35-
result: ContentScanningDisableResponse;
36-
}>
37-
)._thenUnwrap((obj) => obj.result);
38-
}
39-
40-
/**
41-
* Enable Content Scanning.
42-
*/
43-
enable(
44-
params: ContentScanningEnableParams,
45-
options?: Core.RequestOptions,
46-
): Core.APIPromise<ContentScanningEnableResponse> {
47-
const { zone_id } = params;
48-
return (
49-
this._client.post(`/zones/${zone_id}/content-upload-scan/enable`, options) as Core.APIPromise<{
50-
result: ContentScanningEnableResponse;
51-
}>
52-
)._thenUnwrap((obj) => obj.result);
53-
}
54-
}
55-
56-
export type ContentScanningDisableResponse = unknown;
57-
58-
export type ContentScanningEnableResponse = unknown;
59-
60-
export interface ContentScanningDisableParams {
61-
/**
62-
* Defines an identifier.
63-
*/
64-
zone_id: string;
65-
}
66-
67-
export interface ContentScanningEnableParams {
68-
/**
69-
* Defines an identifier.
70-
*/
71-
zone_id: string;
7212
}
7313

7414
ContentScanning.Payloads = Payloads;
75-
ContentScanning.PayloadCreateResponsesSinglePage = PayloadCreateResponsesSinglePage;
76-
ContentScanning.PayloadListResponsesSinglePage = PayloadListResponsesSinglePage;
77-
ContentScanning.PayloadDeleteResponsesSinglePage = PayloadDeleteResponsesSinglePage;
7815
ContentScanning.Settings = Settings;
7916

8017
export declare namespace ContentScanning {
81-
export {
82-
type ContentScanningDisableResponse as ContentScanningDisableResponse,
83-
type ContentScanningEnableResponse as ContentScanningEnableResponse,
84-
type ContentScanningDisableParams as ContentScanningDisableParams,
85-
type ContentScanningEnableParams as ContentScanningEnableParams,
86-
};
87-
88-
export {
89-
Payloads as Payloads,
90-
type PayloadCreateResponse as PayloadCreateResponse,
91-
type PayloadListResponse as PayloadListResponse,
92-
type PayloadDeleteResponse as PayloadDeleteResponse,
93-
PayloadCreateResponsesSinglePage as PayloadCreateResponsesSinglePage,
94-
PayloadListResponsesSinglePage as PayloadListResponsesSinglePage,
95-
PayloadDeleteResponsesSinglePage as PayloadDeleteResponsesSinglePage,
96-
type PayloadCreateParams as PayloadCreateParams,
97-
type PayloadListParams as PayloadListParams,
98-
type PayloadDeleteParams as PayloadDeleteParams,
99-
};
18+
export { Payloads as Payloads };
10019

101-
export {
102-
Settings as Settings,
103-
type SettingGetResponse as SettingGetResponse,
104-
type SettingGetParams as SettingGetParams,
105-
};
20+
export { Settings as Settings };
10621
}
Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
export { ContentScanning } from './content-scanning';
4-
export {
5-
PayloadCreateResponsesSinglePage,
6-
PayloadListResponsesSinglePage,
7-
PayloadDeleteResponsesSinglePage,
8-
Payloads,
9-
type PayloadCreateResponse,
10-
type PayloadListResponse,
11-
type PayloadDeleteResponse,
12-
type PayloadCreateParams,
13-
type PayloadListParams,
14-
type PayloadDeleteParams,
15-
} from './payloads';
16-
export { Settings, type SettingGetResponse, type SettingGetParams } from './settings';
4+
export { Payloads } from './payloads';
5+
export { Settings } from './settings';
Lines changed: 1 addition & 153 deletions
Original file line numberDiff line numberDiff line change
@@ -1,157 +1,5 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../../resource';
4-
import * as Core from '../../core';
5-
import { SinglePage } from '../../pagination';
64

7-
export class Payloads extends APIResource {
8-
/**
9-
* Add custom scan expressions for Content Scanning.
10-
*/
11-
create(
12-
params: PayloadCreateParams,
13-
options?: Core.RequestOptions,
14-
): Core.PagePromise<PayloadCreateResponsesSinglePage, PayloadCreateResponse> {
15-
const { zone_id, body } = params;
16-
return this._client.getAPIList(
17-
`/zones/${zone_id}/content-upload-scan/payloads`,
18-
PayloadCreateResponsesSinglePage,
19-
{ body: body, method: 'post', ...options },
20-
);
21-
}
22-
23-
/**
24-
* Get a list of existing custom scan expressions for Content Scanning.
25-
*/
26-
list(
27-
params: PayloadListParams,
28-
options?: Core.RequestOptions,
29-
): Core.PagePromise<PayloadListResponsesSinglePage, PayloadListResponse> {
30-
const { zone_id } = params;
31-
return this._client.getAPIList(
32-
`/zones/${zone_id}/content-upload-scan/payloads`,
33-
PayloadListResponsesSinglePage,
34-
options,
35-
);
36-
}
37-
38-
/**
39-
* Delete a Content Scan Custom Expression.
40-
*/
41-
delete(
42-
expressionId: string,
43-
params: PayloadDeleteParams,
44-
options?: Core.RequestOptions,
45-
): Core.PagePromise<PayloadDeleteResponsesSinglePage, PayloadDeleteResponse> {
46-
const { zone_id } = params;
47-
return this._client.getAPIList(
48-
`/zones/${zone_id}/content-upload-scan/payloads/${expressionId}`,
49-
PayloadDeleteResponsesSinglePage,
50-
{ method: 'delete', ...options },
51-
);
52-
}
53-
}
54-
55-
export class PayloadCreateResponsesSinglePage extends SinglePage<PayloadCreateResponse> {}
56-
57-
export class PayloadListResponsesSinglePage extends SinglePage<PayloadListResponse> {}
58-
59-
export class PayloadDeleteResponsesSinglePage extends SinglePage<PayloadDeleteResponse> {}
60-
61-
/**
62-
* Defines a custom scan expression to match Content Scanning on.
63-
*/
64-
export interface PayloadCreateResponse {
65-
/**
66-
* defines the unique ID for this custom scan expression.
67-
*/
68-
id?: string;
69-
70-
/**
71-
* Defines the ruleset expression to use in matching content objects.
72-
*/
73-
payload?: string;
74-
}
75-
76-
/**
77-
* Defines a custom scan expression to match Content Scanning on.
78-
*/
79-
export interface PayloadListResponse {
80-
/**
81-
* defines the unique ID for this custom scan expression.
82-
*/
83-
id?: string;
84-
85-
/**
86-
* Defines the ruleset expression to use in matching content objects.
87-
*/
88-
payload?: string;
89-
}
90-
91-
/**
92-
* Defines a custom scan expression to match Content Scanning on.
93-
*/
94-
export interface PayloadDeleteResponse {
95-
/**
96-
* defines the unique ID for this custom scan expression.
97-
*/
98-
id?: string;
99-
100-
/**
101-
* Defines the ruleset expression to use in matching content objects.
102-
*/
103-
payload?: string;
104-
}
105-
106-
export interface PayloadCreateParams {
107-
/**
108-
* Path param: Defines an identifier.
109-
*/
110-
zone_id: string;
111-
112-
/**
113-
* Body param:
114-
*/
115-
body: Array<PayloadCreateParams.Body>;
116-
}
117-
118-
export namespace PayloadCreateParams {
119-
export interface Body {
120-
/**
121-
* Defines the ruleset expression to use in matching content objects.
122-
*/
123-
payload: string;
124-
}
125-
}
126-
127-
export interface PayloadListParams {
128-
/**
129-
* Defines an identifier.
130-
*/
131-
zone_id: string;
132-
}
133-
134-
export interface PayloadDeleteParams {
135-
/**
136-
* Defines an identifier.
137-
*/
138-
zone_id: string;
139-
}
140-
141-
Payloads.PayloadCreateResponsesSinglePage = PayloadCreateResponsesSinglePage;
142-
Payloads.PayloadListResponsesSinglePage = PayloadListResponsesSinglePage;
143-
Payloads.PayloadDeleteResponsesSinglePage = PayloadDeleteResponsesSinglePage;
144-
145-
export declare namespace Payloads {
146-
export {
147-
type PayloadCreateResponse as PayloadCreateResponse,
148-
type PayloadListResponse as PayloadListResponse,
149-
type PayloadDeleteResponse as PayloadDeleteResponse,
150-
PayloadCreateResponsesSinglePage as PayloadCreateResponsesSinglePage,
151-
PayloadListResponsesSinglePage as PayloadListResponsesSinglePage,
152-
PayloadDeleteResponsesSinglePage as PayloadDeleteResponsesSinglePage,
153-
type PayloadCreateParams as PayloadCreateParams,
154-
type PayloadListParams as PayloadListParams,
155-
type PayloadDeleteParams as PayloadDeleteParams,
156-
};
157-
}
5+
export class Payloads extends APIResource {}

0 commit comments

Comments
 (0)