test

Author: charliegerard

types/api.d.ts

@@ -7,143 +7,143 @@
 export interface paths {
   "/npm/{package}/{version}/issues": {
     /**
-     * Get issues by package
+     * Get issues by package 
      * @description 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/npm/issue) the full list of issues.
-     *
+     * 
      * This endpoint consumes 1 unit of your quota.
      */
     get: operations["getIssuesByNPMPackage"];
   };
   "/npm/{package}/{version}/score": {
     /**
-     * Get score by package
+     * Get score by package 
      * @description Get all the scores and metrics by category that are used to evaluate the package version.
-     *
+     * 
      * This endpoint consumes 1 unit of your quota.
      */
     get: operations["getScoreByNPMPackage"];
   };
   "/report/delete/{id}": {
     /**
-     * Delete a report
+     * Delete a report 
      * @description Delete a specific project report.
-     *
+     * 
      * This endpoint consumes 10 units of your quota.
      */
     delete: operations["deleteReport"];
   };
   "/report/list": {
     /**
-     * Get list of reports
+     * Get list of reports 
      * @description Get all your project reports.
-     *
+     * 
      * This endpoint consumes 10 units of your quota.
      */
     get: operations["getReportList"];
   };
   "/report/upload": {
     /**
-     * Create a report
+     * Create a report 
      * @description Upload a lockfile to get your project analyzed by Socket.
      * You can upload multiple lockfiles in the same request, but each filename must be unique.
-     *
+     * 
      * The name of the file must be in the supported list.
-     *
+     * 
      * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
-     *
+     * 
      * This endpoint consumes 100 units of your quota.
      */
     put: operations["createReport"];
   };
   "/report/view/{id}": {
     /**
-     * View a report
+     * View a report 
      * @description Get all the issues, packages, and scores related to an specific project report.
-     *
+     * 
      * This endpoint consumes 10 units of your quota.
      */
     get: operations["getReport"];
   };
   "/report/supported": {
     /**
-     * Get supported files for report
+     * Get supported files for report 
      * @description Get a list of supported files for project report generation.
      * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
-     *
+     * 
      * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
      * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     get: operations["getReportSupportedFiles"];
   };
   "/openapi": {
     /**
-     * Returns the OpenAPI definition
+     * Returns the OpenAPI definition 
      * @description Retrieve the API specification in an Openapi JSON format.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     get: operations["getOpenAPI"];
   };
   "/quota": {
     /**
-     * Get quota
+     * Get quota 
      * @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     get: operations["getQuota"];
   };
   "/organizations": {
     /**
-     * List organizations
+     * List organizations 
      * @description Get information on the current organizations associated with the API key.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     get: operations["getOrganizations"];
   };
   "/settings": {
     /**
-     * Calculate settings
+     * Calculate settings 
      * @description Get your current settings the requested organizations and default settings to allow deferrals.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     post: operations["postSettings"];
   };
   "/repo/list": {
     /**
-     * Get list of repos and their latest project report
+     * Get list of repos and their latest project report 
      * @description Get all repositories in an org including their latest project report.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     get: operations["getRepoList"];
   };
   "/dependencies/search": {
     /**
-     * Search dependencies
+     * Search dependencies 
      * @description Search for any dependency that is being used in your organization.
-     *
+     * 
      * This endpoint consumes 0 units of your quota.
      */
     post: operations["searchDependencies"];
   };
   "/dependencies/upload": {
     /**
-     * Create a snapshot of all dependencies from manifest information
+     * Create a snapshot of all dependencies from manifest information 
      * @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
      * You can upload multiple lockfiles in the same request, but each filename must be unique.
-     *
+     * 
      * The name of the file must be in the supported list.
-     *
+     * 
      * For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
-     *
+     * 
      * This endpoint consumes 100 units of your quota.
      */
     post: operations["createDependenciesSnapshot"];
@@ -1249,12 +1249,12 @@ export interface components {
       value: Record<string, never>;
     };
     /**
-     * @default low
+     * @default low 
      * @enum {string}
      */
     SocketIssueSeverity: "low" | "middle" | "high" | "critical";
     /**
-     * @default miscellaneous
+     * @default miscellaneous 
      * @enum {string}
      */
     SocketCategory: "supplyChainRisk" | "quality" | "maintenance" | "vulnerability" | "license" | "miscellaneous";
@@ -1431,12 +1431,12 @@ export type external = Record<string, never>;
 export interface operations {
 
   /**
-   * Get issues by package
+   * Get issues by package 
    * @description 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/npm/issue) the full list of issues.
-   *
+   * 
    * This endpoint consumes 1 unit of your quota.
    */
   getIssuesByNPMPackage: {
@@ -1461,9 +1461,9 @@ export interface operations {
     };
   };
   /**
-   * Get score by package
+   * Get score by package 
    * @description Get all the scores and metrics by category that are used to evaluate the package version.
-   *
+   * 
    * This endpoint consumes 1 unit of your quota.
    */
   getScoreByNPMPackage: {
@@ -1488,9 +1488,9 @@ export interface operations {
     };
   };
   /**
-   * Delete a report
+   * Delete a report 
    * @description Delete a specific project report.
-   *
+   * 
    * This endpoint consumes 10 units of your quota.
    */
   deleteReport: {
@@ -1517,9 +1517,9 @@ export interface operations {
     };
   };
   /**
-   * Get list of reports
+   * Get list of reports 
    * @description Get all your project reports.
-   *
+   * 
    * This endpoint consumes 10 units of your quota.
    */
   getReportList: {
@@ -1543,14 +1543,14 @@ export interface operations {
     };
   };
   /**
-   * Create a report
+   * Create a report 
    * @description Upload a lockfile to get your project analyzed by Socket.
    * You can upload multiple lockfiles in the same request, but each filename must be unique.
-   *
+   * 
    * The name of the file must be in the supported list.
-   *
+   * 
    * For example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.
-   *
+   * 
    * This endpoint consumes 100 units of your quota.
    */
   createReport: {
@@ -1583,9 +1583,9 @@ export interface operations {
     };
   };
   /**
-   * View a report
+   * View a report 
    * @description Get all the issues, packages, and scores related to an specific project report.
-   *
+   * 
    * This endpoint consumes 10 units of your quota.
    */
   getReport: {
@@ -1609,13 +1609,13 @@ export interface operations {
     };
   };
   /**
-   * Get supported files for report
+   * Get supported files for report 
    * @description Get a list of supported files for project report generation.
    * Files are categorized first by environment (e.g. NPM or PyPI), then by name.
-   *
+   * 
    * Files whose names match the patterns returned by this endpoint can be uploaded for report generation.
    * Examples of supported filenames include `package.json`, `package-lock.json`, and `yarn.lock`.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   getReportSupportedFiles: {
@@ -1638,9 +1638,9 @@ export interface operations {
     };
   };
   /**
-   * Returns the OpenAPI definition
+   * Returns the OpenAPI definition 
    * @description Retrieve the API specification in an Openapi JSON format.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   getOpenAPI: {
@@ -1655,9 +1655,9 @@ export interface operations {
     };
   };
   /**
-   * Get quota
+   * Get quota 
    * @description Get your current API quota. You can use this endpoint to prevent doing requests that might spend all your quota.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   getQuota: {
@@ -1676,9 +1676,9 @@ export interface operations {
     };
   };
   /**
-   * List organizations
+   * List organizations 
    * @description Get information on the current organizations associated with the API key.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   getOrganizations: {
@@ -1707,9 +1707,9 @@ export interface operations {
     };
   };
   /**
-   * Calculate settings
+   * Calculate settings 
    * @description Get your current settings the requested organizations and default settings to allow deferrals.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   postSettings: {
@@ -1758,9 +1758,9 @@ export interface operations {
     };
   };
   /**
-   * Get list of repos and their latest project report
+   * Get list of repos and their latest project report 
    * @description Get all repositories in an org including their latest project report.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   getRepoList: {
@@ -1804,9 +1804,9 @@ export interface operations {
     };
   };
   /**
-   * Search dependencies
+   * Search dependencies 
    * @description Search for any dependency that is being used in your organization.
-   *
+   * 
    * This endpoint consumes 0 units of your quota.
    */
   searchDependencies: {
@@ -1858,14 +1858,14 @@ export interface operations {
     };
   };
   /**
-   * Create a snapshot of all dependencies from manifest information
+   * Create a snapshot of all dependencies from manifest information 
    * @description Upload a set of manifest or lockfiles to get your dependency tree analyzed by Socket.
    * You can upload multiple lockfiles in the same request, but each filename must be unique.
-   *
+   * 
    * The name of the file must be in the supported list.
-   *
+   * 
    * For example, these are valid filenames: "requirements.txt", "package.json", "folder/package.json", and "deep/nested/folder/package.json".
-   *
+   * 
    * This endpoint consumes 100 units of your quota.
    */
   createDependenciesSnapshot: {