Skip to content

Commit

Permalink
feat(api): OpenAPI spec update via Stainless API (#190)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored and stainless-bot committed Mar 21, 2024
1 parent 354cf29 commit 9bbb0b2
Show file tree
Hide file tree
Showing 6 changed files with 123 additions and 85 deletions.
20 changes: 10 additions & 10 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3179,33 +3179,33 @@ Methods:

Types:

- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedItem</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelIndicatorFeedMetadata</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IntelUpdateFeed</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedCreateResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedUpdateResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedListResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedDataResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">IndicatorFeedGetResponse</a></code>

Methods:

- <code title="post /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">create</a>({ ...params }) -> IntelIndicatorFeedItem</code>
- <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IntelUpdateFeed</code>
- <code title="post /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">create</a>({ ...params }) -> IndicatorFeedCreateResponse</code>
- <code title="put /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">update</a>(feedId, { ...params }) -> IndicatorFeedUpdateResponse</code>
- <code title="get /accounts/{account_id}/intel/indicator-feeds">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">list</a>({ ...params }) -> IndicatorFeedListResponse</code>
- <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">data</a>(feedId, { ...params }) -> string</code>
- <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">get</a>(feedId, { ...params }) -> IntelIndicatorFeedMetadata</code>
- <code title="get /accounts/{account_id}/intel/indicator-feeds/{feed_id}">client.intel.indicatorFeeds.<a href="./src/resources/intel/indicator-feeds/indicator-feeds.ts">get</a>(feedId, { ...params }) -> IndicatorFeedGetResponse</code>

### Permissions

Types:

- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionListItem</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">IntelPermissionsUpdate</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionCreateResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionListResponse</a></code>
- <code><a href="./src/resources/intel/indicator-feeds/permissions.ts">PermissionDeleteResponse</a></code>

Methods:

- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/add">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">create</a>({ ...params }) -> IntelPermissionsUpdate</code>
- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/add">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">create</a>({ ...params }) -> PermissionCreateResponse</code>
- <code title="get /accounts/{account_id}/intel/indicator-feeds/permissions/view">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">list</a>({ ...params }) -> PermissionListResponse</code>
- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/remove">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">delete</a>({ ...params }) -> IntelPermissionsUpdate</code>
- <code title="put /accounts/{account_id}/intel/indicator-feeds/permissions/remove">client.intel.indicatorFeeds.permissions.<a href="./src/resources/intel/indicator-feeds/permissions.ts">delete</a>({ ...params }) -> PermissionDeleteResponse</code>

## Sinkholes

Expand Down
26 changes: 13 additions & 13 deletions src/resources/intel/index.ts
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

export { AttackSurfaceReport } from './attack-surface-report/index';
export { Intel } from './intel';
export { IntelASN, ASNGetParams, ASN } from './asn/index';
export { IntelDomain, DomainGetParams, Domains } from './domains/index';
export {
IntelDomainHistory,
DomainHistoryGetResponse,
DomainHistoryGetParams,
DomainHistory,
} from './domain-history';
export { IntelIPList, IPListGetResponse, IPListGetParams, IPLists } from './ip-lists';
export {
IntelIndicatorFeedItem,
IntelIndicatorFeedMetadata,
IntelUpdateFeed,
IndicatorFeedCreateResponse,
IndicatorFeedUpdateResponse,
IndicatorFeedListResponse,
IndicatorFeedDataResponse,
IndicatorFeedGetResponse,
IndicatorFeedCreateParams,
IndicatorFeedUpdateParams,
IndicatorFeedListParams,
IndicatorFeedDataParams,
IndicatorFeedGetParams,
IndicatorFeeds,
} from './indicator-feeds/index';
export { Intel } from './intel';
export { IntelASN, ASNGetParams, ASN } from './asn/index';
export { IntelDomain, DomainGetParams, Domains } from './domains/index';
export {
IntelDomainHistory,
DomainHistoryGetResponse,
DomainHistoryGetParams,
DomainHistory,
} from './domain-history';
export { IntelIPList, IPListGetResponse, IPListGetParams, IPLists } from './ip-lists';
export { IntelPassiveDNSByIP, DNSGetParams, DNS } from './dns';
export { IntelSchemasIP, IPGetResponse, IPGetParams, IPs } from './ips';
export { IntelSinkholesSinkholeItem, SinkholeListResponse, SinkholeListParams, Sinkholes } from './sinkholes';
Expand Down
10 changes: 5 additions & 5 deletions src/resources/intel/indicator-feeds/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

export {
IntelIndicatorFeedItem,
IntelIndicatorFeedMetadata,
IntelUpdateFeed,
IndicatorFeedCreateResponse,
IndicatorFeedUpdateResponse,
IndicatorFeedListResponse,
IndicatorFeedDataResponse,
IndicatorFeedGetResponse,
IndicatorFeedCreateParams,
IndicatorFeedUpdateParams,
IndicatorFeedListParams,
Expand All @@ -14,9 +14,9 @@ export {
IndicatorFeeds,
} from './indicator-feeds';
export {
IntelPermissionListItem,
IntelPermissionsUpdate,
PermissionCreateResponse,
PermissionListResponse,
PermissionDeleteResponse,
PermissionCreateParams,
PermissionListParams,
PermissionDeleteParams,
Expand Down
97 changes: 63 additions & 34 deletions src/resources/intel/indicator-feeds/indicator-feeds.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ export class IndicatorFeeds extends APIResource {
create(
params: IndicatorFeedCreateParams,
options?: Core.RequestOptions,
): Core.APIPromise<IntelIndicatorFeedItem> {
): Core.APIPromise<IndicatorFeedCreateResponse> {
const { account_id, ...body } = params;
return (
this._client.post(`/accounts/${account_id}/intel/indicator-feeds`, {
body,
...options,
}) as Core.APIPromise<{ result: IntelIndicatorFeedItem }>
}) as Core.APIPromise<{ result: IndicatorFeedCreateResponse }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -32,13 +32,13 @@ export class IndicatorFeeds extends APIResource {
feedId: number,
params: IndicatorFeedUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<IntelUpdateFeed> {
): Core.APIPromise<IndicatorFeedUpdateResponse> {
const { account_id, ...body } = params;
return (
this._client.put(
`/accounts/${account_id}/intel/indicator-feeds/${feedId}/snapshot`,
multipartFormRequestOptions({ body, ...options }),
) as Core.APIPromise<{ result: IntelUpdateFeed }>
) as Core.APIPromise<{ result: IndicatorFeedUpdateResponse }>
)._thenUnwrap((obj) => obj.result);
}

Expand Down Expand Up @@ -79,18 +79,18 @@ export class IndicatorFeeds extends APIResource {
feedId: number,
params: IndicatorFeedGetParams,
options?: Core.RequestOptions,
): Core.APIPromise<IntelIndicatorFeedMetadata> {
): Core.APIPromise<IndicatorFeedGetResponse> {
const { account_id } = params;
return (
this._client.get(
`/accounts/${account_id}/intel/indicator-feeds/${feedId}`,
options,
) as Core.APIPromise<{ result: IntelIndicatorFeedMetadata }>
) as Core.APIPromise<{ result: IndicatorFeedGetResponse }>
)._thenUnwrap((obj) => obj.result);
}
}

export interface IntelIndicatorFeedItem {
export interface IndicatorFeedCreateResponse {
/**
* The unique identifier for the indicator feed
*/
Expand All @@ -117,7 +117,57 @@ export interface IntelIndicatorFeedItem {
name?: string;
}

export interface IntelIndicatorFeedMetadata {
export interface IndicatorFeedUpdateResponse {
/**
* Feed id
*/
file_id?: number;

/**
* Name of the file unified in our system
*/
filename?: string;

/**
* Current status of upload, should be unified
*/
status?: string;
}

export type IndicatorFeedListResponse = Array<IndicatorFeedListResponse.IndicatorFeedListResponseItem>;

export namespace IndicatorFeedListResponse {
export interface IndicatorFeedListResponseItem {
/**
* The unique identifier for the indicator feed
*/
id?: number;

/**
* The date and time when the data entry was created
*/
created_on?: string;

/**
* The description of the example test
*/
description?: string;

/**
* The date and time when the data entry was last modified
*/
modified_on?: string;

/**
* The name of the indicator feed
*/
name?: string;
}
}

export type IndicatorFeedDataResponse = string;

export interface IndicatorFeedGetResponse {
/**
* The unique identifier for the indicator feed
*/
Expand Down Expand Up @@ -149,27 +199,6 @@ export interface IntelIndicatorFeedMetadata {
name?: string;
}

export interface IntelUpdateFeed {
/**
* Feed id
*/
file_id?: number;

/**
* Name of the file unified in our system
*/
filename?: string;

/**
* Current status of upload, should be unified
*/
status?: string;
}

export type IndicatorFeedListResponse = Array<IntelIndicatorFeedItem>;

export type IndicatorFeedDataResponse = string;

export interface IndicatorFeedCreateParams {
/**
* Path param: Identifier
Expand Down Expand Up @@ -221,20 +250,20 @@ export interface IndicatorFeedGetParams {
}

export namespace IndicatorFeeds {
export import IntelIndicatorFeedItem = IndicatorFeedsAPI.IntelIndicatorFeedItem;
export import IntelIndicatorFeedMetadata = IndicatorFeedsAPI.IntelIndicatorFeedMetadata;
export import IntelUpdateFeed = IndicatorFeedsAPI.IntelUpdateFeed;
export import IndicatorFeedCreateResponse = IndicatorFeedsAPI.IndicatorFeedCreateResponse;
export import IndicatorFeedUpdateResponse = IndicatorFeedsAPI.IndicatorFeedUpdateResponse;
export import IndicatorFeedListResponse = IndicatorFeedsAPI.IndicatorFeedListResponse;
export import IndicatorFeedDataResponse = IndicatorFeedsAPI.IndicatorFeedDataResponse;
export import IndicatorFeedGetResponse = IndicatorFeedsAPI.IndicatorFeedGetResponse;
export import IndicatorFeedCreateParams = IndicatorFeedsAPI.IndicatorFeedCreateParams;
export import IndicatorFeedUpdateParams = IndicatorFeedsAPI.IndicatorFeedUpdateParams;
export import IndicatorFeedListParams = IndicatorFeedsAPI.IndicatorFeedListParams;
export import IndicatorFeedDataParams = IndicatorFeedsAPI.IndicatorFeedDataParams;
export import IndicatorFeedGetParams = IndicatorFeedsAPI.IndicatorFeedGetParams;
export import Permissions = PermissionsAPI.Permissions;
export import IntelPermissionListItem = PermissionsAPI.IntelPermissionListItem;
export import IntelPermissionsUpdate = PermissionsAPI.IntelPermissionsUpdate;
export import PermissionCreateResponse = PermissionsAPI.PermissionCreateResponse;
export import PermissionListResponse = PermissionsAPI.PermissionListResponse;
export import PermissionDeleteResponse = PermissionsAPI.PermissionDeleteResponse;
export import PermissionCreateParams = PermissionsAPI.PermissionCreateParams;
export import PermissionListParams = PermissionsAPI.PermissionListParams;
export import PermissionDeleteParams = PermissionsAPI.PermissionDeleteParams;
Expand Down
49 changes: 29 additions & 20 deletions src/resources/intel/indicator-feeds/permissions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ export class Permissions extends APIResource {
create(
params: PermissionCreateParams,
options?: Core.RequestOptions,
): Core.APIPromise<IntelPermissionsUpdate> {
): Core.APIPromise<PermissionCreateResponse> {
const { account_id, ...body } = params;
return (
this._client.put(`/accounts/${account_id}/intel/indicator-feeds/permissions/add`, {
body,
...options,
}) as Core.APIPromise<{ result: IntelPermissionsUpdate }>
}) as Core.APIPromise<{ result: PermissionCreateResponse }>
)._thenUnwrap((obj) => obj.result);
}

Expand All @@ -40,43 +40,52 @@ export class Permissions extends APIResource {
delete(
params: PermissionDeleteParams,
options?: Core.RequestOptions,
): Core.APIPromise<IntelPermissionsUpdate> {
): Core.APIPromise<PermissionDeleteResponse> {
const { account_id, ...body } = params;
return (
this._client.put(`/accounts/${account_id}/intel/indicator-feeds/permissions/remove`, {
body,
...options,
}) as Core.APIPromise<{ result: IntelPermissionsUpdate }>
}) as Core.APIPromise<{ result: PermissionDeleteResponse }>
)._thenUnwrap((obj) => obj.result);
}
}

export interface IntelPermissionListItem {
export interface PermissionCreateResponse {
/**
* The unique identifier for the indicator feed
* Whether the update succeeded or not
*/
id?: number;
success?: boolean;
}

/**
* The description of the example test
*/
description?: string;
export type PermissionListResponse = Array<PermissionListResponse.PermissionListResponseItem>;

/**
* The name of the indicator feed
*/
name?: string;
export namespace PermissionListResponse {
export interface PermissionListResponseItem {
/**
* The unique identifier for the indicator feed
*/
id?: number;

/**
* The description of the example test
*/
description?: string;

/**
* The name of the indicator feed
*/
name?: string;
}
}

export interface IntelPermissionsUpdate {
export interface PermissionDeleteResponse {
/**
* Whether the update succeeded or not
*/
success?: boolean;
}

export type PermissionListResponse = Array<IntelPermissionListItem>;

export interface PermissionCreateParams {
/**
* Path param: Identifier
Expand Down Expand Up @@ -119,9 +128,9 @@ export interface PermissionDeleteParams {
}

export namespace Permissions {
export import IntelPermissionListItem = PermissionsAPI.IntelPermissionListItem;
export import IntelPermissionsUpdate = PermissionsAPI.IntelPermissionsUpdate;
export import PermissionCreateResponse = PermissionsAPI.PermissionCreateResponse;
export import PermissionListResponse = PermissionsAPI.PermissionListResponse;
export import PermissionDeleteResponse = PermissionsAPI.PermissionDeleteResponse;
export import PermissionCreateParams = PermissionsAPI.PermissionCreateParams;
export import PermissionListParams = PermissionsAPI.PermissionListParams;
export import PermissionDeleteParams = PermissionsAPI.PermissionDeleteParams;
Expand Down
6 changes: 3 additions & 3 deletions src/resources/intel/intel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ export namespace Intel {
export import IntelWhois = WhoisAPI.IntelWhois;
export import WhoisGetParams = WhoisAPI.WhoisGetParams;
export import IndicatorFeeds = IndicatorFeedsAPI.IndicatorFeeds;
export import IntelIndicatorFeedItem = IndicatorFeedsAPI.IntelIndicatorFeedItem;
export import IntelIndicatorFeedMetadata = IndicatorFeedsAPI.IntelIndicatorFeedMetadata;
export import IntelUpdateFeed = IndicatorFeedsAPI.IntelUpdateFeed;
export import IndicatorFeedCreateResponse = IndicatorFeedsAPI.IndicatorFeedCreateResponse;
export import IndicatorFeedUpdateResponse = IndicatorFeedsAPI.IndicatorFeedUpdateResponse;
export import IndicatorFeedListResponse = IndicatorFeedsAPI.IndicatorFeedListResponse;
export import IndicatorFeedDataResponse = IndicatorFeedsAPI.IndicatorFeedDataResponse;
export import IndicatorFeedGetResponse = IndicatorFeedsAPI.IndicatorFeedGetResponse;
export import IndicatorFeedCreateParams = IndicatorFeedsAPI.IndicatorFeedCreateParams;
export import IndicatorFeedUpdateParams = IndicatorFeedsAPI.IndicatorFeedUpdateParams;
export import IndicatorFeedListParams = IndicatorFeedsAPI.IndicatorFeedListParams;
Expand Down

0 comments on commit 9bbb0b2

Please sign in to comment.