@socketsecurity/sdk 1.9.0 → 1.9.2

package/dist/socket-sdk-class.d.ts

@@ -40,6 +40,13 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     createDependenciesSnapshot(filepaths: string[], pathsRelativeTo?: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'createDependenciesSnapshot'>>;
+    /**
+     * Create a diff scan from two full scan IDs.
+     * Compares two existing full scans to identify changes.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    createOrgDiffScanFromIds(orgSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'createOrgDiffScanFromIds'>>;
     /**
      * Create a comprehensive security scan for an organization.
      * Uploads project files and initiates full security analysis.
@@ -54,13 +61,27 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     createOrgRepo(orgSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'createOrgRepo'>>;
+    /**
+     * Create a new repository label for an organization.
+     * Adds label for repository categorization and management.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    createOrgRepoLabel(orgSlug: string, repoSlug: string, labelData: QueryParams): Promise<SocketSdkResult<'createOrgRepoLabel'>>;
     /**
      * Create a security scan by uploading project files.
      * Analyzes uploaded files for security vulnerabilities and policy violations.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    createScanFromFilepaths(filepaths: string[], pathsRelativeTo?: string, issueRules?: Record<string, boolean>): Promise<SocketSdkResult<'createReport'>>;
+    createScanFromFilepaths(filepaths: string[], pathsRelativeTo?: string, issueRules?: Record<string, boolean> | undefined): Promise<SocketSdkResult<'createReport'>>;
+    /**
+     * Delete a diff scan from an organization.
+     * Permanently removes diff scan data and results.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    deleteOrgDiffScan(orgSlug: string, diffScanId: string): Promise<SocketSdkResult<'deleteOrgDiffScan'>>;
     /**
      * Delete a full scan from an organization.
      * Permanently removes scan data and results.
@@ -75,6 +96,49 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     deleteOrgRepo(orgSlug: string, repoSlug: string): Promise<SocketSdkResult<'deleteOrgRepo'>>;
+    /**
+     * Delete a repository label from an organization.
+     * Removes label and associated configuration.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    deleteOrgRepoLabel(orgSlug: string, repoSlug: string, labelSlug: string): Promise<SocketSdkResult<'deleteOrgRepoLabel'>>;
+    /**
+     * Delete a scan report permanently.
+     * Removes scan data and analysis results from the system.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    deleteReport(reportId: string): Promise<SocketSdkResult<'deleteReport'>>;
+    /**
+     * Export scan results in CycloneDX SBOM format.
+     * Returns Software Bill of Materials compliant with CycloneDX standard.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    exportCDX(orgSlug: string, fullScanId: string): Promise<SocketSdkResult<'exportCDX'>>;
+    /**
+     * Export scan results in SPDX SBOM format.
+     * Returns Software Bill of Materials compliant with SPDX standard.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    exportSPDX(orgSlug: string, fullScanId: string): Promise<SocketSdkResult<'exportSPDX'>>;
+    /**
+     * Execute a raw GET request to any API endpoint with configurable response type.
+     * Supports both throwing (default) and non-throwing modes.
+     * @param urlPath - API endpoint path (e.g., 'organizations')
+     * @param options - Request options including responseType and throws behavior
+     * @returns Raw response, parsed data, or SocketSdkGenericResult based on options
+     */
+    getApi<T = IncomingMessage>(urlPath: string, options?: GetOptions | undefined): Promise<T | SocketSdkGenericResult<T>>;
+    /**
+     * Get list of API tokens for an organization.
+     * Returns organization API tokens with metadata and permissions.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getAPITokens(orgSlug: string): Promise<SocketSdkResult<'getAPITokens'>>;
     /**
      * Retrieve audit log events for an organization.
      * Returns chronological log of security and administrative actions.
@@ -82,6 +146,13 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getAuditLogEvents(orgSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'getAuditLogEvents'>>;
+    /**
+     * Get details for a specific diff scan.
+     * Returns comparison between two full scans with artifact changes.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getDiffScanById(orgSlug: string, diffScanId: string): Promise<SocketSdkResult<'getDiffScanById'>>;
     /**
      * Retrieve the enabled entitlements for an organization.
      *
@@ -117,21 +188,6 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getOrganizations(): Promise<SocketSdkResult<'getOrganizations'>>;
-    /**
-     * Stream a full scan's results to file or stdout.* Provides efficient streaming for large scan datasets.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    streamOrgFullScan(orgSlug: string, fullScanId: string, output?: string | boolean): Promise<SocketSdkResult<'getOrgFullScan'>>;
-    /**
-     * Stream patches for artifacts in a scan report.
-     *
-     * This method streams all available patches for artifacts in a scan.
-     * Free tier users will only receive free patches.
-     *
-     * Note: This method returns a ReadableStream for processing large datasets.
-     */
-    streamPatchesFromScan(orgSlug: string, scanId: string): Promise<ReadableStream<ArtifactPatches>>;
     /**
      * Get complete full scan results in memory.
      * Returns entire scan data as JSON for programmatic processing.
@@ -166,6 +222,20 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getOrgRepo(orgSlug: string, repoSlug: string): Promise<SocketSdkResult<'getOrgRepo'>>;
+    /**
+     * Get details for a specific repository label.
+     * Returns label configuration and metadata.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getOrgRepoLabel(orgSlug: string, repoSlug: string, labelSlug: string): Promise<SocketSdkResult<'getOrgRepoLabel'>>;
+    /**
+     * Get list of repository labels for an organization.
+     * Returns all labels configured for repository management.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getOrgRepoLabelList(orgSlug: string, repoSlug: string): Promise<SocketSdkResult<'getOrgRepoLabelList'>>;
     /**
      * List all repositories in an organization.
      * Returns paginated list of repository metadata and status.
@@ -179,6 +249,13 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getOrgSecurityPolicy(orgSlug: string): Promise<SocketSdkResult<'getOrgSecurityPolicy'>>;
+    /**
+     * Get organization triage settings and status.
+     * Returns alert triage configuration and current state.
+     *
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getOrgTriage(orgSlug: string): Promise<SocketSdkResult<'getOrgTriage'>>;
     /**
      * Get current API quota usage and limits.
      * Returns remaining requests, rate limits, and quota reset times.
@@ -207,13 +284,6 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getScanList(): Promise<SocketSdkResult<'getReportList'>>;
-    /**
-     * Get list of file types and formats supported for scanning.
-     * Returns supported manifest files, lockfiles, and configuration formats.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    getSupportedScanFiles(): Promise<SocketSdkResult<'getReportSupportedFiles'>>;
     /**
      * Get security score for a specific npm package and version.
      * Returns numerical security rating and scoring breakdown.
@@ -222,77 +292,40 @@ export declare class SocketSdk {
      */
     getScoreByNpmPackage(pkgName: string, version: string): Promise<SocketSdkResult<'getScoreByNPMPackage'>>;
     /**
-     * Update user or organization settings.
-     * Configures preferences, notifications, and security policies.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    postSettings(selectors: Array<{
-        organization?: string;
-    }>): Promise<SocketSdkResult<'postSettings'>>;
-    /**
-     * Search for dependencies across monitored projects.
-     * Returns matching packages with security information and usage patterns.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    searchDependencies(queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'searchDependencies'>>;
-    /**
-     * Update configuration for an organization repository.
-     * Modifies monitoring settings, branch configuration, and scan preferences.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    updateOrgRepo(orgSlug: string, repoSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'updateOrgRepo'>>;
-    /**
-     * Upload manifest files for dependency analysis.
-     * Processes package files to create dependency snapshots and security analysis.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    uploadManifestFiles(orgSlug: string, filepaths: string[], pathsRelativeTo?: string): Promise<UploadManifestFilesReturnType | UploadManifestFilesError>;
-    /**
-     * View detailed information about a specific patch by its UUID.
-     *
-     * This method retrieves comprehensive patch details including files,
-     * vulnerabilities, description, license, and tier information.
-     */
-    viewPatch(orgSlug: string, uuid: string): Promise<PatchViewResponse>;
-    /**
-     * Delete a scan report permanently.
-     * Removes scan data and analysis results from the system.
+     * Get list of file types and formats supported for scanning.
+     * Returns supported manifest files, lockfiles, and configuration formats.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    deleteReport(reportId: string): Promise<SocketSdkResult<'deleteReport'>>;
+    getSupportedScanFiles(): Promise<SocketSdkResult<'getReportSupportedFiles'>>;
     /**
-     * Export scan results in CycloneDX SBOM format.
-     * Returns Software Bill of Materials compliant with CycloneDX standard.
+     * List all diff scans for an organization.
+     * Returns paginated list of diff scan metadata and status.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    exportCDX(orgSlug: string, fullScanId: string): Promise<SocketSdkResult<'exportCDX'>>;
+    listOrgDiffScans(orgSlug: string): Promise<SocketSdkResult<'listOrgDiffScans'>>;
     /**
-     * Export scan results in SPDX SBOM format.
-     * Returns Software Bill of Materials compliant with SPDX standard.
+     * Create a new API token for an organization.
+     * Generates API token with specified scopes and metadata.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    exportSPDX(orgSlug: string, fullScanId: string): Promise<SocketSdkResult<'exportSPDX'>>;
+    postAPIToken(orgSlug: string, tokenData: QueryParams): Promise<SocketSdkResult<'postAPIToken'>>;
     /**
-     * Get list of API tokens for an organization.
-     * Returns organization API tokens with metadata and permissions.
+     * Revoke an API token for an organization.
+     * Permanently disables the token and removes access.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    getAPITokens(orgSlug: string): Promise<SocketSdkResult<'getAPITokens'>>;
+    postAPITokensRevoke(orgSlug: string, tokenId: string): Promise<SocketSdkResult<'postAPITokensRevoke'>>;
     /**
-     * Create a new API token for an organization.
-     * Generates API token with specified scopes and metadata.
+     * Rotate an API token for an organization.
+     * Generates new token value while preserving token metadata.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    postAPIToken(orgSlug: string, tokenData: QueryParams): Promise<SocketSdkResult<'postAPIToken'>>;
+    postAPITokensRotate(orgSlug: string, tokenId: string): Promise<SocketSdkResult<'postAPITokensRotate'>>;
     /**
      * Update an existing API token for an organization.
      * Modifies token metadata, scopes, or other properties.
@@ -301,38 +334,44 @@ export declare class SocketSdk {
      */
     postAPITokenUpdate(orgSlug: string, tokenId: string, updateData: QueryParams): Promise<SocketSdkResult<'postAPITokenUpdate'>>;
     /**
-     * Rotate an API token for an organization.
-     * Generates new token value while preserving token metadata.
+     * Update user or organization settings.
+     * Configures preferences, notifications, and security policies.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    postAPITokensRotate(orgSlug: string, tokenId: string): Promise<SocketSdkResult<'postAPITokensRotate'>>;
+    postSettings(selectors: Array<{
+        organization?: string | undefined;
+    }>): Promise<SocketSdkResult<'postSettings'>>;
     /**
-     * Revoke an API token for an organization.
-     * Permanently disables the token and removes access.
+     * Search for dependencies across monitored projects.
+     * Returns matching packages with security information and usage patterns.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    postAPITokensRevoke(orgSlug: string, tokenId: string): Promise<SocketSdkResult<'postAPITokensRevoke'>>;
+    searchDependencies(queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'searchDependencies'>>;
     /**
-     * Update organization's security policy configuration.* Modifies alert rules, severity thresholds, and enforcement settings.
-     *
-     * @throws {Error} When server returns 5xx status codes
+     * Send POST or PUT request with JSON body and return parsed JSON response.
+     * Supports both throwing (default) and non-throwing modes.
+     * @param urlPath - API endpoint path (e.g., 'organizations')
+     * @param options - Request options including method, body, and throws behavior
+     * @returns Parsed JSON response or SocketSdkGenericResult based on options
      */
-    updateOrgSecurityPolicy(orgSlug: string, policyData: QueryParams): Promise<SocketSdkResult<'updateOrgSecurityPolicy'>>;
+    sendApi<T>(urlPath: string, options?: SendOptions | undefined): Promise<T | SocketSdkGenericResult<T>>;
     /**
-     * Update organization's license policy configuration.* Modifies allowed, restricted, and monitored license types.
+     * Stream a full scan's results to file or stdout.* Provides efficient streaming for large scan datasets.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    updateOrgLicensePolicy(orgSlug: string, policyData: QueryParams, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'updateOrgLicensePolicy'>>;
+    streamOrgFullScan(orgSlug: string, fullScanId: string, output?: string | boolean): Promise<SocketSdkResult<'getOrgFullScan'>>;
     /**
-     * Get organization triage settings and status.
-     * Returns alert triage configuration and current state.
+     * Stream patches for artifacts in a scan report.
      *
-     * @throws {Error} When server returns 5xx status codes
+     * This method streams all available patches for artifacts in a scan.
+     * Free tier users will only receive free patches.
+     *
+     * Note: This method returns a ReadableStream for processing large datasets.
      */
-    getOrgTriage(orgSlug: string): Promise<SocketSdkResult<'getOrgTriage'>>;
+    streamPatchesFromScan(orgSlug: string, scanId: string): Promise<ReadableStream<ArtifactPatches>>;
     /**
      * Update alert triage status for an organization.
      * Modifies alert resolution status and triage decisions.
@@ -341,26 +380,18 @@ export declare class SocketSdk {
      */
     updateOrgAlertTriage(orgSlug: string, alertId: string, triageData: QueryParams): Promise<SocketSdkResult<'updateOrgAlertTriage'>>;
     /**
-     * Get list of repository labels for an organization.
-     * Returns all labels configured for repository management.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    getOrgRepoLabelList(orgSlug: string, repoSlug: string): Promise<SocketSdkResult<'getOrgRepoLabelList'>>;
-    /**
-     * Create a new repository label for an organization.
-     * Adds label for repository categorization and management.
+     * Update organization's license policy configuration.* Modifies allowed, restricted, and monitored license types.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    createOrgRepoLabel(orgSlug: string, repoSlug: string, labelData: QueryParams): Promise<SocketSdkResult<'createOrgRepoLabel'>>;
+    updateOrgLicensePolicy(orgSlug: string, policyData: QueryParams, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'updateOrgLicensePolicy'>>;
     /**
-     * Get details for a specific repository label.
-     * Returns label configuration and metadata.
+     * Update configuration for an organization repository.
+     * Modifies monitoring settings, branch configuration, and scan preferences.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    getOrgRepoLabel(orgSlug: string, repoSlug: string, labelSlug: string): Promise<SocketSdkResult<'getOrgRepoLabel'>>;
+    updateOrgRepo(orgSlug: string, repoSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'updateOrgRepo'>>;
     /**
      * Update a repository label for an organization.
      * Modifies label properties and configuration.
@@ -369,55 +400,23 @@ export declare class SocketSdk {
      */
     updateOrgRepoLabel(orgSlug: string, repoSlug: string, labelSlug: string, labelData: QueryParams): Promise<SocketSdkResult<'updateOrgRepoLabel'>>;
     /**
-     * Delete a repository label from an organization.
-     * Removes label and associated configuration.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    deleteOrgRepoLabel(orgSlug: string, repoSlug: string, labelSlug: string): Promise<SocketSdkResult<'deleteOrgRepoLabel'>>;
-    /**
-     * Get details for a specific diff scan.
-     * Returns comparison between two full scans with artifact changes.
-     *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    getDiffScanById(orgSlug: string, diffScanId: string): Promise<SocketSdkResult<'getDiffScanById'>>;
-    /**
-     * Create a diff scan from two full scan IDs.
-     * Compares two existing full scans to identify changes.
+     * Update organization's security policy configuration.* Modifies alert rules, severity thresholds, and enforcement settings.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    createOrgDiffScanFromIds(orgSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'createOrgDiffScanFromIds'>>;
+    updateOrgSecurityPolicy(orgSlug: string, policyData: QueryParams): Promise<SocketSdkResult<'updateOrgSecurityPolicy'>>;
     /**
-     * List all diff scans for an organization.
-     * Returns paginated list of diff scan metadata and status.
+     * Upload manifest files for dependency analysis.
+     * Processes package files to create dependency snapshots and security analysis.
      *
      * @throws {Error} When server returns 5xx status codes
      */
-    listOrgDiffScans(orgSlug: string): Promise<SocketSdkResult<'listOrgDiffScans'>>;
+    uploadManifestFiles(orgSlug: string, filepaths: string[], pathsRelativeTo?: string): Promise<UploadManifestFilesReturnType | UploadManifestFilesError>;
     /**
-     * Delete a diff scan from an organization.
-     * Permanently removes diff scan data and results.
+     * View detailed information about a specific patch by its UUID.
      *
-     * @throws {Error} When server returns 5xx status codes
-     */
-    deleteOrgDiffScan(orgSlug: string, diffScanId: string): Promise<SocketSdkResult<'deleteOrgDiffScan'>>;
-    /**
-     * Execute a raw GET request to any API endpoint with configurable response type.
-     * Supports both throwing (default) and non-throwing modes.
-     * @param urlPath - API endpoint path (e.g., 'organizations')
-     * @param options - Request options including responseType and throws behavior
-     * @returns Raw response, parsed data, or SocketSdkGenericResult based on options
-     */
-    getApi<T = IncomingMessage>(urlPath: string, options?: GetOptions | undefined): Promise<T | SocketSdkGenericResult<T>>;
-    /**
-     * Send POST or PUT request with JSON body and return parsed JSON response.
-     * Supports both throwing (default) and non-throwing modes.
-     * @param urlPath - API endpoint path (e.g., 'organizations')
-     * @param options - Request options including method, body, and throws behavior
-     * @returns Parsed JSON response or SocketSdkGenericResult based on options
+     * This method retrieves comprehensive patch details including files,
+     * vulnerabilities, description, license, and tier information.
      */
-    sendApi<T>(urlPath: string, options?: SendOptions | undefined): Promise<T | SocketSdkGenericResult<T>>;
+    viewPatch(orgSlug: string, uuid: string): Promise<PatchViewResponse>;
 }
-//# sourceMappingURL=socket-sdk-class.d.ts.map