@sonatype/nexus-iq-api-client 0.156.0

package/dist/esm/models/index.d.ts

@@ -0,0 +1,197 @@
+export * from './Action';
+export * from './ApiApplicationBaseDTO';
+export * from './ApiApplicationCategoryDTO';
+export * from './ApiApplicationDTO';
+export * from './ApiApplicationEvaluationCommitDTO';
+export * from './ApiApplicationEvaluationResultDTOV2';
+export * from './ApiApplicationEvaluationStatusDTOV2';
+export * from './ApiApplicationListDTO';
+export * from './ApiApplicationReportDTOV2';
+export * from './ApiApplicationTagDTO';
+export * from './ApiApplicationViolationDTOV2';
+export * from './ApiApplicationViolationListDTOV2';
+export * from './ApiApplicationWaiverDTO';
+export * from './ApiArtifactoryConnectionDTO';
+export * from './ApiArtifactoryConnectionStatusRequestDTO';
+export * from './ApiArtifactoryConnectionStatusResponseDTO';
+export * from './ApiComponentChangeActionDTO';
+export * from './ApiComponentDTOV2';
+export * from './ApiComponentDetailsDTOV2';
+export * from './ApiComponentDetailsRequestDTOV2';
+export * from './ApiComponentDetailsResultDTOV2';
+export * from './ApiComponentEvaluationRequestDTOV2';
+export * from './ApiComponentEvaluationResultDTOV2';
+export * from './ApiComponentEvaluationTicketDTOV2';
+export * from './ApiComponentIdentifierDTOV2';
+export * from './ApiComponentOrPurlIdentifierDTOV2';
+export * from './ApiComponentPolicyViolationDTO';
+export * from './ApiComponentPolicyViolationListDTOV2';
+export * from './ApiComponentPolicyWaiversDTO';
+export * from './ApiComponentProjectDataDTO';
+export * from './ApiComponentProjectMetadataDTO';
+export * from './ApiComponentProjectScmDTO';
+export * from './ApiComponentProjectScmDetailsDTO';
+export * from './ApiComponentProjectScmMetadataDTO';
+export * from './ApiComponentReleasedFromQuarantineDTO';
+export * from './ApiComponentRemediationDTO';
+export * from './ApiComponentRemediationValueDTO';
+export * from './ApiComponentTransitivePolicyViolationsDTO';
+export * from './ApiComponentWaiversDTO';
+export * from './ApiComponentsInQuarantineDTO';
+export * from './ApiCompositeSourceControlDTO';
+export * from './ApiCompositeValueDTOBoolean';
+export * from './ApiCompositeValueDTOString';
+export * from './ApiConditionFactReasonDTO';
+export * from './ApiConstraintFactDTO';
+export * from './ApiConstraintViolationDTO';
+export * from './ApiConstraintViolationReasonDTO';
+export * from './ApiCrossStageViolationDTOV2';
+export * from './ApiCrowdConfigurationDTO';
+export * from './ApiDataRetentionPoliciesDTO';
+export * from './ApiDependencyDataDTO';
+export * from './ApiDependencyTreeNodeDTO';
+export * from './ApiDependencyTreeResponseDTO';
+export * from './ApiEnhancedPolicyViolationDTOV2';
+export * from './ApiEvaluationResultCounterDTO';
+export * from './ApiFirewallQuarantineSummaryDTO';
+export * from './ApiFirewallReleaseQuarantineConfigDTO';
+export * from './ApiFirewallReleaseQuarantineSummaryDTO';
+export * from './ApiHashComponentIdentifierDTO';
+export * from './ApiHashComponentIdentifiersDTO';
+export * from './ApiJiraConfigurationDTO';
+export * from './ApiLabelDTO';
+export * from './ApiLicenseDTO';
+export * from './ApiLicenseDataDTO';
+export * from './ApiLicenseDataDTOV2';
+export * from './ApiLicenseLegalApplicationReportDTO';
+export * from './ApiLicenseLegalComponentDTO';
+export * from './ApiLicenseLegalComponentReportDTO';
+export * from './ApiLicenseLegalCopyrightDTO';
+export * from './ApiLicenseLegalDataDTO';
+export * from './ApiLicenseLegalFileDTO';
+export * from './ApiLicenseLegalMetadataDTO';
+export * from './ApiLicenseLegalObligationDTO';
+export * from './ApiLicenseLegalStageScanDTO';
+export * from './ApiLicenseThreatDTOV2';
+export * from './ApiMailConfigurationDTO';
+export * from './ApiMatchStateSummaryDTOV2';
+export * from './ApiMemberDTO';
+export * from './ApiMetricsReportingQueryDTOV2';
+export * from './ApiMoveApplicationResponseDTOV2';
+export * from './ApiOrganizationDTO';
+export * from './ApiOrganizationListDTO';
+export * from './ApiOwnerArtifactoryConnectionDTO';
+export * from './ApiOwnerDTO';
+export * from './ApiPolicyDTO';
+export * from './ApiPolicyListDTO';
+export * from './ApiPolicyViolationDTOV2';
+export * from './ApiPolicyViolationDiffDTO';
+export * from './ApiPolicyViolationForDiffDTO';
+export * from './ApiPolicyViolationStageDTO';
+export * from './ApiPolicyWaiverDTO';
+export * from './ApiPolicyWaiversApplicableToViolationDTO';
+export * from './ApiPromoteScanRequestDTOV2';
+export * from './ApiProxyServerConfigurationDTO';
+export * from './ApiPullRequestResult';
+export * from './ApiPullRequestResults';
+export * from './ApiReportComponentDTOV2';
+export * from './ApiReportComponentPolicyViolationsDTOV2';
+export * from './ApiReportConstraintConditionDTOV2';
+export * from './ApiReportConstraintViolationDTOV2';
+export * from './ApiReportHistoryDTO';
+export * from './ApiReportPolicyDataDTOV2';
+export * from './ApiReportPolicyViolationDTOV2';
+export * from './ApiReportRawDataDTOV2';
+export * from './ApiReportResultsDTO';
+export * from './ApiReportRetentionPoliciesDTO';
+export * from './ApiReportRetentionPolicyDTO';
+export * from './ApiRepositoryComponentDTO';
+export * from './ApiRepositoryComponentPath';
+export * from './ApiRepositoryComponentPolicyViolationDTO';
+export * from './ApiRepositoryComponentsInQuarantineDTO';
+export * from './ApiRepositoryDTO';
+export * from './ApiRepositoryPathResponseDTO';
+export * from './ApiRepositoryPathVersions';
+export * from './ApiRepositoryWaiverDTO';
+export * from './ApiReverseProxyAuthenticationConfigurationDTO';
+export * from './ApiRoleDTO';
+export * from './ApiRoleListDTO';
+export * from './ApiRoleMemberMappingDTO';
+export * from './ApiRoleMemberMappingListDTO';
+export * from './ApiSamlConfigurationDTO';
+export * from './ApiSamlConfigurationResponseDTO';
+export * from './ApiSearchCriteriaDTOV2';
+export * from './ApiSearchResultDTOV2';
+export * from './ApiSearchResultsDTOV2';
+export * from './ApiSecurityDataDTO';
+export * from './ApiSecurityIssueDTO';
+export * from './ApiSecurityVulnerabilityOverrideDTOV2';
+export * from './ApiSecurityVulnerabilityOverrideResponseDTOV2';
+export * from './ApiSourceControlConfigurationDTO';
+export * from './ApiSourceControlDTO';
+export * from './ApiSourceControlEvaluationRequestDTO';
+export * from './ApiStagePolicyViolationComponentDTO';
+export * from './ApiStaleApplicationEvaluationDTO';
+export * from './ApiStaleEvaluationStageDTO';
+export * from './ApiStaleEvaluationsDTO';
+export * from './ApiStaleRepositoryEvaluationDTO';
+export * from './ApiStaleWaiverDTO';
+export * from './ApiStaleWaiversResponseDTO';
+export * from './ApiStatusDTO';
+export * from './ApiSuccessMetricsRetentionPolicyDTO';
+export * from './ApiTagDTO';
+export * from './ApiThirdPartyScanResultDTO';
+export * from './ApiUserDTO';
+export * from './ApiUserListDTO';
+export * from './ApiUserTokenDTO';
+export * from './ApiUserTokenExistsDTO';
+export * from './ApiVersionChangeOptionDTO';
+export * from './ApiWaivedPolicyViolationDTO';
+export * from './ApiWaiverOptionsDTO';
+export * from './ApplicableContext';
+export * from './ApplicableLabels';
+export * from './ApplicableTagsDTO';
+export * from './ApplicationTag';
+export * from './ApplicationTagsByOwnerDTO';
+export * from './AppliedTagsDTO';
+export * from './AttributionReportTemplateDTO';
+export * from './BodyPart';
+export * from './BodyPartMediaType';
+export * from './ComponentDisplayName';
+export * from './ComponentDisplayNamePart';
+export * from './ComponentFact';
+export * from './ComponentIdentifier';
+export * from './ComponentObligationAttributionDTO';
+export * from './ConditionFact';
+export * from './ConfigurationValidationResult';
+export * from './ConstraintFact';
+export * from './ContentDisposition';
+export * from './CweId';
+export * from './FormDataBodyPart';
+export * from './FormDataContentDisposition';
+export * from './FormDataMultiPart';
+export * from './GroupingByDTO';
+export * from './InnerSourceData';
+export * from './LabelsByOwner';
+export * from './LegalSourceLinkDTO';
+export * from './LicenseObligationDTO';
+export * from './LicenseThreatGroupDTO';
+export * from './MultiPart';
+export * from './ParameterizedHeader';
+export * from './PolicyAlert';
+export * from './PolicyEvaluationResult';
+export * from './PolicyFact';
+export * from './PolicyOwner';
+export * from './PolicyTag';
+export * from './ReferenceLink';
+export * from './RootCause';
+export * from './SearchResultDTO';
+export * from './SearchResultItemDTO';
+export * from './SecurityVulnerabilityData';
+export * from './SecurityVulnerabilitySeverity';
+export * from './SecurityVulnerabilityWeakness';
+export * from './StageData';
+export * from './TagsByOwnerDTO';
+export * from './TriggerReference';
+export * from './ValidationResult';
+export * from './VulnerabilitySource';

package/dist/esm/models/index.js

@@ -0,0 +1,199 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Action';
+export * from './ApiApplicationBaseDTO';
+export * from './ApiApplicationCategoryDTO';
+export * from './ApiApplicationDTO';
+export * from './ApiApplicationEvaluationCommitDTO';
+export * from './ApiApplicationEvaluationResultDTOV2';
+export * from './ApiApplicationEvaluationStatusDTOV2';
+export * from './ApiApplicationListDTO';
+export * from './ApiApplicationReportDTOV2';
+export * from './ApiApplicationTagDTO';
+export * from './ApiApplicationViolationDTOV2';
+export * from './ApiApplicationViolationListDTOV2';
+export * from './ApiApplicationWaiverDTO';
+export * from './ApiArtifactoryConnectionDTO';
+export * from './ApiArtifactoryConnectionStatusRequestDTO';
+export * from './ApiArtifactoryConnectionStatusResponseDTO';
+export * from './ApiComponentChangeActionDTO';
+export * from './ApiComponentDTOV2';
+export * from './ApiComponentDetailsDTOV2';
+export * from './ApiComponentDetailsRequestDTOV2';
+export * from './ApiComponentDetailsResultDTOV2';
+export * from './ApiComponentEvaluationRequestDTOV2';
+export * from './ApiComponentEvaluationResultDTOV2';
+export * from './ApiComponentEvaluationTicketDTOV2';
+export * from './ApiComponentIdentifierDTOV2';
+export * from './ApiComponentOrPurlIdentifierDTOV2';
+export * from './ApiComponentPolicyViolationDTO';
+export * from './ApiComponentPolicyViolationListDTOV2';
+export * from './ApiComponentPolicyWaiversDTO';
+export * from './ApiComponentProjectDataDTO';
+export * from './ApiComponentProjectMetadataDTO';
+export * from './ApiComponentProjectScmDTO';
+export * from './ApiComponentProjectScmDetailsDTO';
+export * from './ApiComponentProjectScmMetadataDTO';
+export * from './ApiComponentReleasedFromQuarantineDTO';
+export * from './ApiComponentRemediationDTO';
+export * from './ApiComponentRemediationValueDTO';
+export * from './ApiComponentTransitivePolicyViolationsDTO';
+export * from './ApiComponentWaiversDTO';
+export * from './ApiComponentsInQuarantineDTO';
+export * from './ApiCompositeSourceControlDTO';
+export * from './ApiCompositeValueDTOBoolean';
+export * from './ApiCompositeValueDTOString';
+export * from './ApiConditionFactReasonDTO';
+export * from './ApiConstraintFactDTO';
+export * from './ApiConstraintViolationDTO';
+export * from './ApiConstraintViolationReasonDTO';
+export * from './ApiCrossStageViolationDTOV2';
+export * from './ApiCrowdConfigurationDTO';
+export * from './ApiDataRetentionPoliciesDTO';
+export * from './ApiDependencyDataDTO';
+export * from './ApiDependencyTreeNodeDTO';
+export * from './ApiDependencyTreeResponseDTO';
+export * from './ApiEnhancedPolicyViolationDTOV2';
+export * from './ApiEvaluationResultCounterDTO';
+export * from './ApiFirewallQuarantineSummaryDTO';
+export * from './ApiFirewallReleaseQuarantineConfigDTO';
+export * from './ApiFirewallReleaseQuarantineSummaryDTO';
+export * from './ApiHashComponentIdentifierDTO';
+export * from './ApiHashComponentIdentifiersDTO';
+export * from './ApiJiraConfigurationDTO';
+export * from './ApiLabelDTO';
+export * from './ApiLicenseDTO';
+export * from './ApiLicenseDataDTO';
+export * from './ApiLicenseDataDTOV2';
+export * from './ApiLicenseLegalApplicationReportDTO';
+export * from './ApiLicenseLegalComponentDTO';
+export * from './ApiLicenseLegalComponentReportDTO';
+export * from './ApiLicenseLegalCopyrightDTO';
+export * from './ApiLicenseLegalDataDTO';
+export * from './ApiLicenseLegalFileDTO';
+export * from './ApiLicenseLegalMetadataDTO';
+export * from './ApiLicenseLegalObligationDTO';
+export * from './ApiLicenseLegalStageScanDTO';
+export * from './ApiLicenseThreatDTOV2';
+export * from './ApiMailConfigurationDTO';
+export * from './ApiMatchStateSummaryDTOV2';
+export * from './ApiMemberDTO';
+export * from './ApiMetricsReportingQueryDTOV2';
+export * from './ApiMoveApplicationResponseDTOV2';
+export * from './ApiOrganizationDTO';
+export * from './ApiOrganizationListDTO';
+export * from './ApiOwnerArtifactoryConnectionDTO';
+export * from './ApiOwnerDTO';
+export * from './ApiPolicyDTO';
+export * from './ApiPolicyListDTO';
+export * from './ApiPolicyViolationDTOV2';
+export * from './ApiPolicyViolationDiffDTO';
+export * from './ApiPolicyViolationForDiffDTO';
+export * from './ApiPolicyViolationStageDTO';
+export * from './ApiPolicyWaiverDTO';
+export * from './ApiPolicyWaiversApplicableToViolationDTO';
+export * from './ApiPromoteScanRequestDTOV2';
+export * from './ApiProxyServerConfigurationDTO';
+export * from './ApiPullRequestResult';
+export * from './ApiPullRequestResults';
+export * from './ApiReportComponentDTOV2';
+export * from './ApiReportComponentPolicyViolationsDTOV2';
+export * from './ApiReportConstraintConditionDTOV2';
+export * from './ApiReportConstraintViolationDTOV2';
+export * from './ApiReportHistoryDTO';
+export * from './ApiReportPolicyDataDTOV2';
+export * from './ApiReportPolicyViolationDTOV2';
+export * from './ApiReportRawDataDTOV2';
+export * from './ApiReportResultsDTO';
+export * from './ApiReportRetentionPoliciesDTO';
+export * from './ApiReportRetentionPolicyDTO';
+export * from './ApiRepositoryComponentDTO';
+export * from './ApiRepositoryComponentPath';
+export * from './ApiRepositoryComponentPolicyViolationDTO';
+export * from './ApiRepositoryComponentsInQuarantineDTO';
+export * from './ApiRepositoryDTO';
+export * from './ApiRepositoryPathResponseDTO';
+export * from './ApiRepositoryPathVersions';
+export * from './ApiRepositoryWaiverDTO';
+export * from './ApiReverseProxyAuthenticationConfigurationDTO';
+export * from './ApiRoleDTO';
+export * from './ApiRoleListDTO';
+export * from './ApiRoleMemberMappingDTO';
+export * from './ApiRoleMemberMappingListDTO';
+export * from './ApiSamlConfigurationDTO';
+export * from './ApiSamlConfigurationResponseDTO';
+export * from './ApiSearchCriteriaDTOV2';
+export * from './ApiSearchResultDTOV2';
+export * from './ApiSearchResultsDTOV2';
+export * from './ApiSecurityDataDTO';
+export * from './ApiSecurityIssueDTO';
+export * from './ApiSecurityVulnerabilityOverrideDTOV2';
+export * from './ApiSecurityVulnerabilityOverrideResponseDTOV2';
+export * from './ApiSourceControlConfigurationDTO';
+export * from './ApiSourceControlDTO';
+export * from './ApiSourceControlEvaluationRequestDTO';
+export * from './ApiStagePolicyViolationComponentDTO';
+export * from './ApiStaleApplicationEvaluationDTO';
+export * from './ApiStaleEvaluationStageDTO';
+export * from './ApiStaleEvaluationsDTO';
+export * from './ApiStaleRepositoryEvaluationDTO';
+export * from './ApiStaleWaiverDTO';
+export * from './ApiStaleWaiversResponseDTO';
+export * from './ApiStatusDTO';
+export * from './ApiSuccessMetricsRetentionPolicyDTO';
+export * from './ApiTagDTO';
+export * from './ApiThirdPartyScanResultDTO';
+export * from './ApiUserDTO';
+export * from './ApiUserListDTO';
+export * from './ApiUserTokenDTO';
+export * from './ApiUserTokenExistsDTO';
+export * from './ApiVersionChangeOptionDTO';
+export * from './ApiWaivedPolicyViolationDTO';
+export * from './ApiWaiverOptionsDTO';
+export * from './ApplicableContext';
+export * from './ApplicableLabels';
+export * from './ApplicableTagsDTO';
+export * from './ApplicationTag';
+export * from './ApplicationTagsByOwnerDTO';
+export * from './AppliedTagsDTO';
+export * from './AttributionReportTemplateDTO';
+export * from './BodyPart';
+export * from './BodyPartMediaType';
+export * from './ComponentDisplayName';
+export * from './ComponentDisplayNamePart';
+export * from './ComponentFact';
+export * from './ComponentIdentifier';
+export * from './ComponentObligationAttributionDTO';
+export * from './ConditionFact';
+export * from './ConfigurationValidationResult';
+export * from './ConstraintFact';
+export * from './ContentDisposition';
+export * from './CweId';
+export * from './FormDataBodyPart';
+export * from './FormDataContentDisposition';
+export * from './FormDataMultiPart';
+export * from './GroupingByDTO';
+export * from './InnerSourceData';
+export * from './LabelsByOwner';
+export * from './LegalSourceLinkDTO';
+export * from './LicenseObligationDTO';
+export * from './LicenseThreatGroupDTO';
+export * from './MultiPart';
+export * from './ParameterizedHeader';
+export * from './PolicyAlert';
+export * from './PolicyEvaluationResult';
+export * from './PolicyFact';
+export * from './PolicyOwner';
+export * from './PolicyTag';
+export * from './ReferenceLink';
+export * from './RootCause';
+export * from './SearchResultDTO';
+export * from './SearchResultItemDTO';
+export * from './SecurityVulnerabilityData';
+export * from './SecurityVulnerabilitySeverity';
+export * from './SecurityVulnerabilityWeakness';
+export * from './StageData';
+export * from './TagsByOwnerDTO';
+export * from './TriggerReference';
+export * from './ValidationResult';
+export * from './VulnerabilitySource';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Sonatype Nexus IQ Server
+ * This documents the available APIs into [Sonatype Nexus IQ Server](https://www.sonatype.com/products/open-source-security-dependency-management) (also knwon as Nexus Lifecycle).
+ *
+ * The version of the OpenAPI document: 156
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | ((name: string) => string);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function exists(json: any, key: string): boolean;
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function mapValues(data: any, fn: (item: any) => any): {};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}