Skip to content

pangea-node-sdk: remove unused options docs in UserIntelService (GEA-12766) #763

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.

Sign up for GitHub

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

Merged
kenany merged 1 commit into from
Feb 26, 2024
Merged

pangea-node-sdk: remove unused options docs in UserIntelService (GEA-12766) #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions packages/pangea-node-sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Removed

- Unused `options` documentation in `UserIntelService`.

## [3.7.0] - 2024-02-26

### Added
Expand Down
18 changes: 4 additions & 14 deletions packages/pangea-node-sdk/src/services/intel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,13 +840,8 @@ export class UserIntelService extends BaseService {
* @summary Look up breached users
* @description Determine if an email address, username, phone number, or IP address was exposed in a security breach.
* @operationId user_intel_post_v1_user_breached
* @param {Intel.User.User.BreachedRequest} request - Request to send to user/breached endpoint
* @param {Object} options - An object of optional parameters. Parameters supported:
* - provider {String} - Use breached data from this provider: "spycloud".
* Default provider defined by the configuration.
* - verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
* - raw {Boolean} - Include raw data from this provider. Default: raw=false.
* @returns {Promise} - A promise representing an async call to the user/breached endpoint.
* @param request Request to send to user/breached endpoint
* @returns A promise representing an async call to the user/breached endpoint.
* @example
* ```js
* const response = await userIntel.userBreached({
Expand All @@ -866,13 +861,8 @@ export class UserIntelService extends BaseService {
* @summary Look up breached users V2
* @description Determine if an email address, username, phone number, or IP address was exposed in a security breach.
* @operationId user_intel_post_v2_user_breached
* @param {Intel.User.User.BreachedBulkRequest} request - Request to send to user/breached endpoint
* @param {Object} options - An object of optional parameters. Parameters supported:
* - provider {String} - Use breached data from this provider: "spycloud".
* Default provider defined by the configuration.
* - verbose {Boolean} - Echo the API parameters in the response. Default: verbose=false.
* - raw {Boolean} - Include raw data from this provider. Default: raw=false.
* @returns {Promise} - A promise representing an async call to the user/breached endpoint.
* @param request Request to send to user/breached endpoint
* @returns A promise representing an async call to the user/breached endpoint.
* @example
* ```js
* const response = await userIntel.userBreachedBulk({
Expand Down