@socketsecurity/sdk 1.7.0 → 1.8.1

package/types/api.d.ts

@@ -15,8 +15,10 @@ export interface paths {
      *
      * More information on purl and CycloneDX:
      *
-     * - [`purl` Spec](https://github.com/package-url/purl-spec)
-     * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
+     //github.com/package-url/purl-spec)
+     * - [`purl` Spec](https:
+     //cyclonedx.org/specification/overview/#components)
+     * - [CycloneDX Spec](https:
      *
      * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
      * Actively running analysis will be returned when available on subsequent runs.
@@ -310,8 +312,7 @@ export interface paths {
   '/orgs/{org_slug}/diff-scans/from-repo/{repo_slug}': {
     /**
      * Create diff scan from repository HEAD full-scan
-     * @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.
-     * Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
+     * @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
      * the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
      *
      * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
@@ -593,7 +594,8 @@ export interface paths {
     /**
      * Get Organization License Policy
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/viewlicensepolicy) instead.
+     //docs.socket.dev/reference/viewlicensepolicy) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Retrieve the license policy of an organization.
      *
@@ -605,8 +607,7 @@ export interface paths {
     get: operations['getOrgLicensePolicy']
     /**
      * Update License Policy
-     * @description Set the organization's license policy
-     *
+     * @description Set the organization's license policy*
      *       ## License policy schema
      *
      * ```json
@@ -641,13 +642,13 @@ export interface paths {
      *   'commercial',
      *   'patent'
      *
-     * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     * Users can learn more about [copyleft tiers](https:
      *
      *
      * ## PURLs
      *
-     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-     *
+     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
      * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
      *
      * ### Examples:
@@ -672,8 +673,7 @@ export interface paths {
   '/orgs/{org_slug}/settings/license-policy/view': {
     /**
      * Get License Policy (Beta)
-     * @description Returns an organization's license policy
-     *
+     * @description Returns an organization's license policy*
      * This endpoint consumes 1 unit of your quota.
      *
      * This endpoint requires the following org token scopes:
@@ -870,11 +870,13 @@ export interface paths {
     /**
      * Get Threat Feed Items (Deprecated)
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgthreatfeeditems) instead.
+     //docs.socket.dev/reference/getorgthreatfeeditems) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Paginated list of threat feed items.
      *
-     * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+     //socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+     * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
      *
      * This endpoint consumes 1 unit of your quota.
      *
@@ -888,7 +890,8 @@ export interface paths {
      * Get Threat Feed Items (Beta)
      * @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
      *
-     * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+     //socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+     * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
      *
      * This endpoint consumes 1 unit of your quota.
      *
@@ -983,13 +986,13 @@ export interface paths {
      *   'commercial',
      *   'patent'
      *
-     * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     * Users can learn more about [copyleft tiers](https:
      *
      *
      * ## PURLs
      *
-     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-     *
+     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
      * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
      *
      * ### Examples:
@@ -1016,10 +1019,10 @@ export interface paths {
     /**
      * Saturate License Policy (Legacy)
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorglicensepolicy) instead.
+     //docs.socket.dev/reference/updateorglicensepolicy) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
-     * Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
-     * license data. For example, the saturated form of a license allow list which only specifies that
+     * Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed* license data. For example, the saturated form of a license allow list which only specifies that
      * licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
      *
      * ```json
@@ -1075,7 +1078,8 @@ export interface paths {
      * PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
      * CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
      *
-     * readers can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     * readers can learn more about [copyleft tiers](https:
      *
      * ### Example request bodies:
      * ```json
@@ -1117,7 +1121,8 @@ export interface paths {
      *     ## Return value
      *
      *     ```json
-     *     // Response schema:
+     // Response schema:
+     *
      *     Array<{
      *       licenseId: string,
      *       name?: string,
@@ -1127,7 +1132,8 @@ export interface paths {
      *       text?: string
      *     }>
      *
-     *     // Example response:
+     // Example response:
+     *
      *     [
      *       {
      *         "licenseId": "Apache-2.0",
@@ -1187,13 +1193,13 @@ export interface paths {
      *   'commercial',
      *   'patent'
      *
-     * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+     * Users can learn more about [copyleft tiers](https:
      *
      *
      * ## PURLs
      *
-     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-     *
+     * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
      * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
      *
      * ### Examples:
@@ -1264,7 +1270,8 @@ export interface paths {
     /**
      * Calculate settings
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorgsecuritypolicy) instead.
+     //docs.socket.dev/reference/updateorgsecuritypolicy) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Get current settings for the requested organizations and default settings to allow deferrals.
      *
@@ -1279,7 +1286,8 @@ export interface paths {
     /**
      * Get supported files for report
      * @deprecated
-     * @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https://docs.socket.dev/reference/getsupportedfiles) instead.
+     //docs.socket.dev/reference/getsupportedfiles) instead.
+     * @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
      *
      * This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
      *
@@ -1299,7 +1307,8 @@ export interface paths {
     /**
      * Delete a report
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+     //docs.socket.dev/reference) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
      *
@@ -1314,7 +1323,8 @@ export interface paths {
     /**
      * Get list of reports
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+     //docs.socket.dev/reference) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
      *
@@ -1329,7 +1339,8 @@ export interface paths {
     /**
      * Create a report
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/createorgfullscan) instead.
+     //docs.socket.dev/reference/createorgfullscan) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
      *
@@ -1351,7 +1362,8 @@ export interface paths {
     /**
      * View a report
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgfullscan) instead.
+     //docs.socket.dev/reference/getorgfullscan) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
      *
@@ -1366,7 +1378,8 @@ export interface paths {
     /**
      * List GitHub repositories
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgrepolist) instead.
+     //docs.socket.dev/reference/getorgrepolist) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
      *
@@ -1381,12 +1394,14 @@ export interface paths {
     /**
      * Get issues by package
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+     //docs.socket.dev/reference) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Get all the issues related with a particular npm package version.
      * This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
      *
-     * You can [see here](https://socket.dev/alerts) the full list of issues.
+     //socket.dev/alerts) the full list of issues.
+     * You can [see here](https:
      *
      * This endpoint consumes 1 unit of your quota.
      *
@@ -1399,7 +1414,8 @@ export interface paths {
     /**
      * Get score by package
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/batchpackagefetch) instead.
+     //docs.socket.dev/reference/batchpackagefetch) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Get all the scores and metrics by category that are used to evaluate the package version.
      *
@@ -1414,20 +1430,17 @@ export interface paths {
      * - quality: Score factors relating to code quality (0-1)
      * - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
      * - linesOfCode: The number of lines of code in the package. Lower count contributes to a higher score.
-     * - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.
-     * - maintenance: Score factors relating to package maintenance (0-1)
+     * - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.* - maintenance: Score factors relating to package maintenance (0-1)
      * - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
      * - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
      * - versionCount: The total number of versions released. Higher count contributes to a higher score.
      * - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
      * - vulnerability: Score factors relating to package vulnerabilities (0-1)
      * - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute to a higher score.
-     * - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.
-     * - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
+     * - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
      * - license: Score factors relating to package licensing (0-1)
      * - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute to a higher score.
-     * - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.
-     * - miscellaneous: Miscellaneous metadata about the package version.
+     * - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.* - miscellaneous: Miscellaneous metadata about the package version.
      * - versionAuthorName/Email: The name and email of the version author.
      * - fileCount: The number of files in the package.
      * - byteCount: The total size in bytes of the package.
@@ -1444,7 +1457,8 @@ export interface paths {
     /**
      * Get organization analytics (unstable)
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
+     //docs.socket.dev/reference/historicalalertstrend) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
      *
@@ -1461,7 +1475,8 @@ export interface paths {
     /**
      * Get repository analytics
      * @deprecated
-     * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
+     //docs.socket.dev/reference/historicalalertstrend) instead.
+     * @description **This endpoint is deprecated.** Use the [successor version](https:
      *
      * Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
      *
@@ -1894,8 +1909,7 @@ export interface components {
        */
       subpath?: string
       /**
-       * @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version
-       * @default
+       * @description Package-specific release identifier, such as PyPI's artifact ID or the specific build/release version* @default
        */
       release?: string
     }
@@ -1987,6 +2001,11 @@ export interface components {
         head?: components['schemas']['ReachabilityResult']
         base?: components['schemas']['ReachabilityResult']
       }
+      /**
+       * @description Generic alert sub-type
+       * @default
+       */
+      subType?: string
     }
     LicenseDetails: Array<{
       /**
@@ -4311,7 +4330,8 @@ export interface components {
       headers: {
         /**
          * @description Retry contacting the endpoint *at least* after seconds.
-         * See https://tools.ietf.org/html/rfc7231#section-7.1.3
+         //tools.ietf.org/html/rfc7231#section-7.1.3
+         * See https:
          */
         'Retry-After'?: number
       }
@@ -4374,8 +4394,10 @@ export interface operations {
    *
    * More information on purl and CycloneDX:
    *
-   * - [`purl` Spec](https://github.com/package-url/purl-spec)
-   * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
+   //github.com/package-url/purl-spec)
+   * - [`purl` Spec](https:
+   //cyclonedx.org/specification/overview/#components)
+   * - [CycloneDX Spec](https:
    *
    * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
    * Actively running analysis will be returned when available on subsequent runs.
@@ -5219,8 +5241,7 @@ export interface operations {
       query?: {
         /**
          * @description The person(s) who created the BOM.
-         * Set this value if you're intending the modify the BOM and claim authorship.
-         */
+         * Set this value if you're intending the modify the BOM and claim authorship.*/
         author?: string
         /** @description Dependency track project group */
         project_group?: string
@@ -5281,8 +5302,7 @@ export interface operations {
       query?: {
         /**
          * @description The person(s) who created the BOM.
-         * Set this value if you're intending the modify the BOM and claim authorship.
-         */
+         * Set this value if you're intending the modify the BOM and claim authorship.*/
         author?: string
         /** @description Dependency track project group */
         project_group?: string
@@ -5676,8 +5696,7 @@ export interface operations {
   }
   /**
    * Create diff scan from repository HEAD full-scan
-   * @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.
-   * Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
+   * @description Create a diff scan between the repository's current HEAD full scan and a new full scan from uploaded manifest files.* Returns metadata about the diff scan. Once the diff scan is created, fetch the diff scan from
    * the [api_url](/reference/getDiffScanById) URL to get the contents of the diff.
    *
    * The maximum number of files you can upload at a time is 5000 and each file can be no bigger than 67 MB.
@@ -10963,7 +10982,8 @@ export interface operations {
   /**
    * Get Organization License Policy
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/viewlicensepolicy) instead.
+   //docs.socket.dev/reference/viewlicensepolicy) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Retrieve the license policy of an organization.
    *
@@ -10995,8 +11015,7 @@ export interface operations {
   }
   /**
    * Update License Policy
-   * @description Set the organization's license policy
-   *
+   * @description Set the organization's license policy*
    *       ## License policy schema
    *
    * ```json
@@ -11031,13 +11050,13 @@ export interface operations {
    *   'commercial',
    *   'patent'
    *
-   * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   * Users can learn more about [copyleft tiers](https:
    *
    *
    * ## PURLs
    *
-   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-   *
+   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
    * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
    *
    * ### Examples:
@@ -11089,8 +11108,7 @@ export interface operations {
   }
   /**
    * Get License Policy (Beta)
-   * @description Returns an organization's license policy
-   *
+   * @description Returns an organization's license policy*
    * This endpoint consumes 1 unit of your quota.
    *
    * This endpoint requires the following org token scopes:
@@ -11239,10 +11257,8 @@ export interface operations {
         'filters.artifactType'?: string
         /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
         'filters.artifactType.notIn'?: string
-        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
-        'filters.alertAction'?: string
-        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
-        'filters.alertAction.notIn'?: string
+        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */ 'filters.alertAction'?: string
+        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ 'filters.alertAction.notIn'?: string
         /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
         'filters.alertActionSourceType'?: string
         /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
@@ -11412,8 +11428,7 @@ export interface operations {
                 artifactName?: string[]
                 /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
                 artifactType?: string[]
-                /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
-                alertAction?: string[]
+                /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ alertAction?: string[]
                 /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
                 alertActionSourceType?: string[]
                 /** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
@@ -11491,10 +11506,8 @@ export interface operations {
         'filters.artifactType'?: string
         /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
         'filters.artifactType.notIn'?: string
-        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */
-        'filters.alertAction'?: string
-        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
-        'filters.alertAction.notIn'?: string
+        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be included */ 'filters.alertAction'?: string
+        /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ 'filters.alertAction.notIn'?: string
         /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be included */
         'filters.alertActionSourceType'?: string
         /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
@@ -11580,8 +11593,7 @@ export interface operations {
                 artifactName?: string[]
                 /** @description Comma-separated list of artifact types (e.g. "npm", "pypi", "gem", "maven", "golang", etc.) that should be excluded */
                 artifactType?: string[]
-                /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */
-                alertAction?: string[]
+                /** @description Comma-separated list of alert actions ("error", "warn", "monitor", or "ignore) that should be excluded */ alertAction?: string[]
                 /** @description Comma-separated list of alert action source types ("fallback", "org-policy", "reachability", "repo-label-policy", "socket-yml", or "triage") that should be excluded */
                 alertActionSourceType?: string[]
                 /** @description Comma-separated list of alert fix types ("upgrade", "cve", or "remove") that should be excluded */
@@ -12596,11 +12608,13 @@ export interface operations {
   /**
    * Get Threat Feed Items (Deprecated)
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgthreatfeeditems) instead.
+   //docs.socket.dev/reference/getorgthreatfeeditems) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Paginated list of threat feed items.
    *
-   * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+   //socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+   * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
    *
    * This endpoint consumes 1 unit of your quota.
    *
@@ -12700,7 +12714,8 @@ export interface operations {
    * Get Threat Feed Items (Beta)
    * @description Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.
    *
-   * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+   //socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.
+   * This endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https:
    *
    * This endpoint consumes 1 unit of your quota.
    *
@@ -12887,13 +12902,13 @@ export interface operations {
    *   'commercial',
    *   'patent'
    *
-   * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   * Users can learn more about [copyleft tiers](https:
    *
    *
    * ## PURLs
    *
-   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-   *
+   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
    * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
    *
    * ### Examples:
@@ -12948,10 +12963,10 @@ export interface operations {
   /**
    * Saturate License Policy (Legacy)
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorglicensepolicy) instead.
+   //docs.socket.dev/reference/updateorglicensepolicy) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
-   * Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed
-   * license data. For example, the saturated form of a license allow list which only specifies that
+   * Get the "saturated" version of a license policy's allow list, filling in the entire set of allowed* license data. For example, the saturated form of a license allow list which only specifies that
    * licenses in the tier "maximal copyleft" are allowed is shown below (note the expanded `allowedStrings` property):
    *
    * ```json
@@ -13007,7 +13022,8 @@ export interface operations {
    * PermissiveTier ::= "model permissive" | "gold" | "silver" | "bronze" | "lead"
    * CopyleftTier ::= "maximal copyleft" | "network copyleft" | "strong copyleft" | "weak copyleft"
    *
-   * readers can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   * readers can learn more about [copyleft tiers](https:
    *
    * ### Example request bodies:
    * ```json
@@ -13078,7 +13094,8 @@ export interface operations {
    *     ## Return value
    *
    *     ```json
-   *     // Response schema:
+   // Response schema:
+   *
    *     Array<{
    *       licenseId: string,
    *       name?: string,
@@ -13088,7 +13105,8 @@ export interface operations {
    *       text?: string
    *     }>
    *
-   *     // Example response:
+   // Example response:
+   *
    *     [
    *       {
    *         "licenseId": "Apache-2.0",
@@ -13148,13 +13166,13 @@ export interface operations {
    *   'commercial',
    *   'patent'
    *
-   * Users can learn more about [copyleft tiers](https://blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   //blueoakcouncil.org/copyleft) and [permissive tiers](https://blueoakcouncil.org/list) by reading the linked resources.
+   * Users can learn more about [copyleft tiers](https:
    *
    *
    * ## PURLs
    *
-   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.
-   *
+   * Users may also modify their license policy's allow and warn lists by using [package URLs](https://github.com/package-url/purl-spec) (aka PURLs), which support glob patterns to allow a range of versions, files and directories, etc.*
    * purl qualifiers which support globs are `filename`, `version_glob`, `artifact_id` and `license_provenance` (primarily used for allowing data from registry metadata).
    *
    * ### Examples:
@@ -13323,7 +13341,8 @@ export interface operations {
   /**
    * Calculate settings
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/updateorgsecuritypolicy) instead.
+   //docs.socket.dev/reference/updateorgsecuritypolicy) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Get current settings for the requested organizations and default settings to allow deferrals.
    *
@@ -13343,8 +13362,7 @@ export interface operations {
       }
     }
     responses: {
-      /** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */
-      200: {
+      /** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */ 200: {
         content: {
           'application/json': {
             defaults: {
@@ -13381,7 +13399,8 @@ export interface operations {
   /**
    * Get supported files for report
    * @deprecated
-   * @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https://docs.socket.dev/reference/getsupportedfiles) instead.
+   //docs.socket.dev/reference/getsupportedfiles) instead.
+   * @description **This endpoint is deprecated.** Deprecated since 2023-01-15. Use the [successor version](https:
    *
    * This route has been moved to the `orgs/{org_slug}/supported-files` endpoint.
    *
@@ -13417,7 +13436,8 @@ export interface operations {
   /**
    * Delete a report
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+   //docs.socket.dev/reference) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.
    *
@@ -13452,7 +13472,8 @@ export interface operations {
   /**
    * Get list of reports
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+   //docs.socket.dev/reference) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.
    *
@@ -13504,7 +13525,8 @@ export interface operations {
   /**
    * Create a report
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/createorgfullscan) instead.
+   //docs.socket.dev/reference/createorgfullscan) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Deprecated: Use `/orgs/{org_slug}/full-scans` instead.
    *
@@ -13552,7 +13574,8 @@ export interface operations {
   /**
    * View a report
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgfullscan) instead.
+   //docs.socket.dev/reference/getorgfullscan) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.
    *
@@ -13585,7 +13608,8 @@ export interface operations {
   /**
    * List GitHub repositories
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/getorgrepolist) instead.
+   //docs.socket.dev/reference/getorgrepolist) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.
    *
@@ -13642,12 +13666,14 @@ export interface operations {
   /**
    * Get issues by package
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference) instead.
+   //docs.socket.dev/reference) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Get all the issues related with a particular npm package version.
    * This endpoint returns the issue type, location, and additional details related to each issue in the `props` attribute.
    *
-   * You can [see here](https://socket.dev/alerts) the full list of issues.
+   //socket.dev/alerts) the full list of issues.
+   * You can [see here](https:
    *
    * This endpoint consumes 1 unit of your quota.
    *
@@ -13678,7 +13704,8 @@ export interface operations {
   /**
    * Get score by package
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/batchpackagefetch) instead.
+   //docs.socket.dev/reference/batchpackagefetch) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Get all the scores and metrics by category that are used to evaluate the package version.
    *
@@ -13693,20 +13720,17 @@ export interface operations {
    * - quality: Score factors relating to code quality (0-1)
    * - qualityIssueLow/Mid/High/Critical: The number of code quality issues of varying severity. Lower numbers contribute to a higher score.
    * - linesOfCode: The number of lines of code in the package. Lower count contributes to a higher score.
-   * - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.
-   * - maintenance: Score factors relating to package maintenance (0-1)
+   * - readmeLength: The length of the package's README file. Longer READMEs contribute to a higher score.* - maintenance: Score factors relating to package maintenance (0-1)
    * - maintainerCount: The number of maintainers for the package. More maintainers contribute to a higher score.
    * - versionsLastWeek/Month/TwoMonths/Year: The number of versions released in different time periods. More recent releases contribute to a higher score.
    * - versionCount: The total number of versions released. Higher count contributes to a higher score.
    * - maintenanceIssueLow/Mid/High/Critical: The number of maintenance issues of varying severity. Lower numbers contribute to a higher score.
    * - vulnerability: Score factors relating to package vulnerabilities (0-1)
    * - vulnerabilityIssueLow/Mid/High/Critical: The number of vulnerability issues of varying severity. Lower numbers contribute to a higher score.
-   * - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.
-   * - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
+   * - dependencyVulnerabilityCount: The number of vulnerabilities in the package's dependencies. Lower count contributes to a higher score.* - vulnerabilityCount: The number of vulnerabilities in the package itself. Lower count contributes to a higher score.
    * - license: Score factors relating to package licensing (0-1)
    * - licenseIssueLow/Mid/High/Critical: The number of license issues of varying severity. Lower numbers contribute to a higher score.
-   * - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.
-   * - miscellaneous: Miscellaneous metadata about the package version.
+   * - licenseQuality: A score indicating the quality/permissiveness of the package's license. Higher quality contributes to a higher score.* - miscellaneous: Miscellaneous metadata about the package version.
    * - versionAuthorName/Email: The name and email of the version author.
    * - fileCount: The number of files in the package.
    * - byteCount: The total size in bytes of the package.
@@ -13741,7 +13765,8 @@ export interface operations {
   /**
    * Get organization analytics (unstable)
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
+   //docs.socket.dev/reference/historicalalertstrend) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
    *
@@ -13811,7 +13836,8 @@ export interface operations {
   /**
    * Get repository analytics
    * @deprecated
-   * @description **This endpoint is deprecated.** Use the [successor version](https://docs.socket.dev/reference/historicalalertstrend) instead.
+   //docs.socket.dev/reference/historicalalertstrend) instead.
+   * @description **This endpoint is deprecated.** Use the [successor version](https:
    *
    * Please implement against the [Historical dependencies](/reference/historicaldependenciestrend) or [Historical alerts](/reference/historicalalertstrend) endpoints.
    *