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): update via SDK Studio #260

Merged
merged 1 commit into from
Apr 9, 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
93 changes: 50 additions & 43 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,10 @@ Methods:
Types:

- <code><a href="./src/resources/user/billing/history.ts">BillingHistory</a></code>
- <code><a href="./src/resources/user/billing/history.ts">HistoryGetResponse</a></code>

Methods:

- <code title="get /user/billing/history">client.user.billing.history.<a href="./src/resources/user/billing/history.ts">get</a>({ ...params }) -> HistoryGetResponse | null</code>
- <code title="get /user/billing/history">client.user.billing.history.<a href="./src/resources/user/billing/history.ts">list</a>({ ...params }) -> BillingHistoriesV4PagePaginationArray</code>

### Profile

Expand Down Expand Up @@ -162,74 +161,74 @@ Methods:
- <code title="patch /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">edit</a>(inviteId, { ...params }) -> UnnamedSchemaRef9444735ca60712dbcf8afd832eb5716a</code>
- <code title="get /user/invites/{invite_id}">client.user.invites.<a href="./src/resources/user/invites.ts">get</a>(inviteId) -> UnnamedSchemaRef9444735ca60712dbcf8afd832eb5716a</code>

## LoadBalancers
## LoadBalancing

### Monitors

Types:

- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorCreateResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorUpdateResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorListResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorDeleteResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorEditResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorGetResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorPreviewResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/monitors.ts">MonitorReferencesResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorCreateResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorUpdateResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorListResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorDeleteResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorEditResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorGetResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorPreviewResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/monitors.ts">MonitorReferencesResponse</a></code>

Methods:

- <code title="post /user/load_balancers/monitors">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">create</a>({ ...params }) -> MonitorCreateResponse</code>
- <code title="put /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">update</a>(monitorId, { ...params }) -> MonitorUpdateResponse</code>
- <code title="get /user/load_balancers/monitors">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">list</a>() -> MonitorListResponsesSinglePage</code>
- <code title="delete /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">delete</a>(monitorId, { ...params }) -> MonitorDeleteResponse</code>
- <code title="patch /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">edit</a>(monitorId, { ...params }) -> MonitorEditResponse</code>
- <code title="get /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">get</a>(monitorId) -> MonitorGetResponse</code>
- <code title="post /user/load_balancers/monitors/{monitor_id}/preview">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">preview</a>(monitorId, { ...params }) -> MonitorPreviewResponse</code>
- <code title="get /user/load_balancers/monitors/{monitor_id}/references">client.user.loadBalancers.monitors.<a href="./src/resources/user/load-balancers/monitors.ts">references</a>(monitorId) -> MonitorReferencesResponse | null</code>
- <code title="post /user/load_balancers/monitors">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">create</a>({ ...params }) -> MonitorCreateResponse</code>
- <code title="put /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">update</a>(monitorId, { ...params }) -> MonitorUpdateResponse</code>
- <code title="get /user/load_balancers/monitors">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">list</a>() -> MonitorListResponsesSinglePage</code>
- <code title="delete /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">delete</a>(monitorId, { ...params }) -> MonitorDeleteResponse</code>
- <code title="patch /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">edit</a>(monitorId, { ...params }) -> MonitorEditResponse</code>
- <code title="get /user/load_balancers/monitors/{monitor_id}">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">get</a>(monitorId) -> MonitorGetResponse</code>
- <code title="post /user/load_balancers/monitors/{monitor_id}/preview">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">preview</a>(monitorId, { ...params }) -> MonitorPreviewResponse</code>
- <code title="get /user/load_balancers/monitors/{monitor_id}/references">client.user.loadBalancing.monitors.<a href="./src/resources/user/load-balancing/monitors.ts">references</a>(monitorId) -> MonitorReferencesResponse | null</code>

### Pools

Types:

- <code><a href="./src/resources/user/load-balancers/pools.ts">PoolDeleteResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/pools.ts">PoolHealthResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/pools.ts">PoolPreviewResponse</a></code>
- <code><a href="./src/resources/user/load-balancers/pools.ts">PoolReferencesResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/pools.ts">PoolDeleteResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/pools.ts">PoolHealthResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/pools.ts">PoolPreviewResponse</a></code>
- <code><a href="./src/resources/user/load-balancing/pools.ts">PoolReferencesResponse</a></code>

Methods:

- <code title="post /user/load_balancers/pools">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">create</a>({ ...params }) -> Pool</code>
- <code title="put /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">update</a>(poolId, { ...params }) -> Pool</code>
- <code title="get /user/load_balancers/pools">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">list</a>({ ...params }) -> PoolsSinglePage</code>
- <code title="delete /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">delete</a>(poolId, { ...params }) -> PoolDeleteResponse</code>
- <code title="patch /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">edit</a>(poolId, { ...params }) -> Pool</code>
- <code title="get /user/load_balancers/pools/{pool_id}">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">get</a>(poolId) -> Pool</code>
- <code title="get /user/load_balancers/pools/{pool_id}/health">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">health</a>(poolId) -> PoolHealthResponse</code>
- <code title="post /user/load_balancers/pools/{pool_id}/preview">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">preview</a>(poolId, { ...params }) -> PoolPreviewResponse</code>
- <code title="get /user/load_balancers/pools/{pool_id}/references">client.user.loadBalancers.pools.<a href="./src/resources/user/load-balancers/pools.ts">references</a>(poolId) -> PoolReferencesResponse | null</code>
- <code title="post /user/load_balancers/pools">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">create</a>({ ...params }) -> Pool</code>
- <code title="put /user/load_balancers/pools/{pool_id}">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">update</a>(poolId, { ...params }) -> Pool</code>
- <code title="get /user/load_balancers/pools">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">list</a>({ ...params }) -> PoolsSinglePage</code>
- <code title="delete /user/load_balancers/pools/{pool_id}">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">delete</a>(poolId, { ...params }) -> PoolDeleteResponse</code>
- <code title="patch /user/load_balancers/pools/{pool_id}">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">edit</a>(poolId, { ...params }) -> Pool</code>
- <code title="get /user/load_balancers/pools/{pool_id}">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">get</a>(poolId) -> Pool</code>
- <code title="get /user/load_balancers/pools/{pool_id}/health">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">health</a>(poolId) -> PoolHealthResponse</code>
- <code title="post /user/load_balancers/pools/{pool_id}/preview">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">preview</a>(poolId, { ...params }) -> PoolPreviewResponse</code>
- <code title="get /user/load_balancers/pools/{pool_id}/references">client.user.loadBalancing.pools.<a href="./src/resources/user/load-balancing/pools.ts">references</a>(poolId) -> PoolReferencesResponse | null</code>

### Preview

Types:

- <code><a href="./src/resources/user/load-balancers/preview.ts">Preview</a></code>
- <code><a href="./src/resources/user/load-balancing/preview.ts">PreviewGetResponse</a></code>

Methods:

- <code title="get /user/load_balancers/preview/{preview_id}">client.user.loadBalancers.preview.<a href="./src/resources/user/load-balancers/preview.ts">get</a>(previewId) -> Preview</code>
- <code title="get /user/load_balancers/preview/{preview_id}">client.user.loadBalancing.preview.<a href="./src/resources/user/load-balancing/preview.ts">get</a>(previewId) -> PreviewGetResponse</code>

### Analytics

Types:

- <code><a href="./src/resources/user/load-balancers/analytics/analytics.ts">Analytics</a></code>
- <code><a href="./src/resources/user/load-balancing/analytics/analytics.ts">Analytics</a></code>

#### Events

Methods:

- <code title="get /user/load_balancing_analytics/events">client.user.loadBalancers.analytics.events.<a href="./src/resources/user/load-balancers/analytics/events.ts">list</a>({ ...params }) -> AnalyticsSinglePage</code>
- <code title="get /user/load_balancing_analytics/events">client.user.loadBalancing.analytics.events.<a href="./src/resources/user/load-balancing/analytics/events.ts">list</a>({ ...params }) -> AnalyticsSinglePage</code>

## Organizations

Expand Down Expand Up @@ -1044,9 +1043,13 @@ Methods:

## Previews

Types:

- <code><a href="./src/resources/load-balancers/previews.ts">PreviewGetResponse</a></code>

Methods:

- <code title="get /accounts/{account_id}/load_balancers/preview/{preview_id}">client.loadBalancers.previews.<a href="./src/resources/load-balancers/previews.ts">get</a>(previewId, { ...params }) -> Preview</code>
- <code title="get /accounts/{account_id}/load_balancers/preview/{preview_id}">client.loadBalancers.previews.<a href="./src/resources/load-balancers/previews.ts">get</a>(previewId, { ...params }) -> PreviewGetResponse</code>

## Regions

Expand Down Expand Up @@ -3085,10 +3088,11 @@ Types:

- <code><a href="./src/resources/intel/dns.ts">DNS</a></code>
- <code><a href="./src/resources/intel/dns.ts">UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050</a></code>
- <code><a href="./src/resources/intel/dns.ts">DNSListResponse</a></code>

Methods:

- <code title="get /accounts/{account_id}/intel/dns">client.intel.dns.<a href="./src/resources/intel/dns.ts">get</a>({ ...params }) -> DNS</code>
- <code title="get /accounts/{account_id}/intel/dns">client.intel.dns.<a href="./src/resources/intel/dns.ts">list</a>({ ...params }) -> DNSListResponsesV4PagePagination</code>

## Domains

Expand Down Expand Up @@ -4686,7 +4690,6 @@ Methods:
Types:

- <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">Tunnel</a></code>
- <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">UnnamedSchemaRefA9c0e0a8cc5fd0e244f41ea806cd954a</a></code>
- <code><a href="./src/resources/zero-trust/tunnels/tunnels.ts">WARPConnectorTunnel</a></code>

Methods:
Expand Down Expand Up @@ -5219,13 +5222,15 @@ Methods:

### Leaks

#### Events

Types:

- <code><a href="./src/resources/radar/bgp/leaks.ts">LeakEventsResponse</a></code>
- <code><a href="./src/resources/radar/bgp/leaks/events.ts">EventListResponse</a></code>

Methods:

- <code title="get /radar/bgp/leaks/events">client.radar.bgp.leaks.<a href="./src/resources/radar/bgp/leaks.ts">events</a>({ ...params }) -> LeakEventsResponse</code>
- <code title="get /radar/bgp/leaks/events">client.radar.bgp.leaks.events.<a href="./src/resources/radar/bgp/leaks/events.ts">list</a>({ ...params }) -> EventListResponsesV4PagePagination</code>

### Top

Expand All @@ -5251,13 +5256,15 @@ Methods:

### Hijacks

#### Events

Types:

- <code><a href="./src/resources/radar/bgp/hijacks.ts">HijackEventsResponse</a></code>
- <code><a href="./src/resources/radar/bgp/hijacks/events.ts">EventListResponse</a></code>

Methods:

- <code title="get /radar/bgp/hijacks/events">client.radar.bgp.hijacks.<a href="./src/resources/radar/bgp/hijacks.ts">events</a>({ ...params }) -> HijackEventsResponse</code>
- <code title="get /radar/bgp/hijacks/events">client.radar.bgp.hijacks.events.<a href="./src/resources/radar/bgp/hijacks/events.ts">list</a>({ ...params }) -> EventListResponsesV4PagePagination</code>

### Routes

Expand Down
4 changes: 2 additions & 2 deletions src/resources/alerting/policies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,10 @@ export interface Filter {
* List of IDs that will be used when dispatching a notification. IDs for email
* type will be the email address.
*/
export type Mechanism = Record<string, Array<Mechanism.UnnamedSchemaWithMapParent1>>;
export type Mechanism = Record<string, Array<Mechanism.UnnamedSchemaWithMapParent2>>;

export namespace Mechanism {
export interface UnnamedSchemaWithMapParent1 {
export interface UnnamedSchemaWithMapParent2 {
/**
* UUID
*/
Expand Down
51 changes: 31 additions & 20 deletions src/resources/intel/dns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,27 @@
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as DNSAPI from 'cloudflare/resources/intel/dns';
import * as Shared from 'cloudflare/resources/shared';
import { V4PagePagination, type V4PagePaginationParams } from 'cloudflare/pagination';

export class DNS extends APIResource {
/**
* Get Passive DNS by IP
*/
get(params: DNSGetParams, options?: Core.RequestOptions): Core.APIPromise<DNS> {
list(
params: DNSListParams,
options?: Core.RequestOptions,
): Core.PagePromise<DNSListResponsesV4PagePagination, DNSListResponse> {
const { account_id, ...query } = params;
return (
this._client.get(`/accounts/${account_id}/intel/dns`, { query, ...options }) as Core.APIPromise<{
result: DNS;
}>
)._thenUnwrap((obj) => obj.result);
return this._client.getAPIList(`/accounts/${account_id}/intel/dns`, DNSListResponsesV4PagePagination, {
query,
...options,
});
}
}

export class DNSListResponsesV4PagePagination extends V4PagePagination<DNSListResponse> {}

export interface DNS {
/**
* Total results returned based on your search parameters.
Expand Down Expand Up @@ -57,34 +63,37 @@ export interface UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050 {
last_seen?: string;
}

export interface DNSGetParams {
/**
* Path param: Identifier
*/
account_id: string;
export interface DNSListResponse {
errors: Array<Shared.ResponseInfo>;

messages: Array<Shared.ResponseInfo>;

result: DNS;

/**
* Query param:
* Whether the API call was successful
*/
ipv4?: string;
success: true;
}

export interface DNSListParams extends V4PagePaginationParams {
/**
* Query param: Requested page within paginated list of results.
* Path param: Identifier
*/
page?: number;
account_id: string;

/**
* Query param: Maximum number of results requested.
* Query param:
*/
per_page?: number;
ipv4?: string;

/**
* Query param:
*/
start_end_params?: DNSGetParams.StartEndParams;
start_end_params?: DNSListParams.StartEndParams;
}

export namespace DNSGetParams {
export namespace DNSListParams {
export interface StartEndParams {
/**
* Defaults to the current date.
Expand All @@ -101,5 +110,7 @@ export namespace DNSGetParams {
export namespace DNS {
export import DNS = DNSAPI.DNS;
export import UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050 = DNSAPI.UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050;
export import DNSGetParams = DNSAPI.DNSGetParams;
export import DNSListResponse = DNSAPI.DNSListResponse;
export import DNSListResponsesV4PagePagination = DNSAPI.DNSListResponsesV4PagePagination;
export import DNSListParams = DNSAPI.DNSListParams;
}
8 changes: 7 additions & 1 deletion src/resources/intel/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

export { ASN, ASNGetParams, ASNResource } from './asn/index';
export { AttackSurfaceReport } from './attack-surface-report/index';
export { DNS, UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050, DNSGetParams } from './dns';
export {
DNS,
UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050,
DNSListResponse,
DNSListParams,
DNSListResponsesV4PagePagination,
} from './dns';
export { Domain, DomainGetParams, Domains } from './domains/index';
export {
DomainHistory,
Expand Down
4 changes: 3 additions & 1 deletion src/resources/intel/intel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ export namespace Intel {
export import ASNGetParams = ASNAPI.ASNGetParams;
export import DNS = DNSAPI.DNS;
export import UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050 = DNSAPI.UnnamedSchemaRefB5e16cee4f32382c294201aedb9fc050;
export import DNSGetParams = DNSAPI.DNSGetParams;
export import DNSListResponse = DNSAPI.DNSListResponse;
export import DNSListResponsesV4PagePagination = DNSAPI.DNSListResponsesV4PagePagination;
export import DNSListParams = DNSAPI.DNSListParams;
export import Domains = DomainsAPI.Domains;
export import Domain = DomainsAPI.Domain;
export import DomainGetParams = DomainsAPI.DomainGetParams;
Expand Down
2 changes: 1 addition & 1 deletion src/resources/load-balancers/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ export {
PoolsSinglePage,
Pools,
} from './pools/index';
export { PreviewGetParams, Previews } from './previews';
export { PreviewGetResponse, PreviewGetParams, Previews } from './previews';
export { RegionGetResponse, RegionListParams, RegionGetParams, Regions } from './regions';
export { SearchGetResponse, SearchGetParams, Searches } from './searches';
1 change: 1 addition & 0 deletions src/resources/load-balancers/load-balancers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1456,6 +1456,7 @@ export namespace LoadBalancers {
export import PoolEditParams = PoolsAPI.PoolEditParams;
export import PoolGetParams = PoolsAPI.PoolGetParams;
export import Previews = PreviewsAPI.Previews;
export import PreviewGetResponse = PreviewsAPI.PreviewGetResponse;
export import PreviewGetParams = PreviewsAPI.PreviewGetParams;
export import Regions = RegionsAPI.Regions;
export import RegionGetResponse = RegionsAPI.RegionGetResponse;
Expand Down
Loading