@semantha/product-sdk 9.2.1

package/dist/requirements/api/index.d.mts

@@ -0,0 +1,466 @@
+import { A as AnalysesReport, a as Analysis, N as FormDataContentDisposition, b as AnalysisInput, B as Entity, v as Classification, g as AnalysisResultComment, w as CurrentUser, F as Evaluation, K as ExcelTemplateDetails, R as ModeEnum, L as ExtendedReference, f as AnalysisResult } from '../../modeEnum-CSw6xLrL.mjs';
+import { RestClient } from '../../rest/index.mjs';
+import 'axios';
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/analyses/report"
+ * This is a generated file do not change manually!
+ */
+declare class ReportEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * @param body string[]? -
+     */
+    post(body: string[], params?: {
+        templateid?: string;
+        timezone?: string;
+    }): Promise<AnalysesReport>;
+    /**
+     * @param body string[]? -
+     */
+    postAsXlsx(body: string[], params?: {
+        templateid?: string;
+        timezone?: string;
+    }): Promise<Blob>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/analyses"
+ * This is a generated file do not change manually!
+ */
+declare class AnalysesEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    report(): ReportEndpoint;
+    get(): Promise<Analysis[]>;
+    delete(): Promise<void>;
+    /**
+     * @param file FormDataContentDisposition? -
+     * @param analysisdata AnalysisInput[]? -
+     * @param similaritythreshold number? -
+     * @param strategy string? -
+     * @param name string? -
+     * @param maxreferences number? -
+     * @param tags string? -
+     * @param documentclassids string[]? -
+     * @param goodmatchesthreshold number? -
+     * @param matchallreferences boolean? -
+     * @param showdocscore boolean? -
+     * @param type string? -
+     * @param promptid string? -
+     */
+    post(data: {
+        file?: FormDataContentDisposition;
+        analysisdata?: AnalysisInput[];
+        similaritythreshold?: number;
+        strategy?: string;
+        name?: string;
+        maxreferences?: number;
+        tags?: string;
+        documentclassids?: string[];
+        goodmatchesthreshold?: number;
+        matchallreferences?: boolean;
+        showdocscore?: boolean;
+        type?: string;
+        promptid?: string;
+    }): Promise<void>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/results/export"
+ * This is a generated file do not change manually!
+ */
+declare class ExportEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * @param body string[]? -
+     */
+    postAsXlsx(body: string[], params?: {
+        templateid?: string;
+    }): Promise<Blob>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/results"
+ * This is a generated file do not change manually!
+ */
+declare class ResultsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    export(): ExportEndpoint;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/analyses/{analysisid}"
+ * This is a generated file do not change manually!
+ */
+declare class AnalysisEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly analysisid;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string, analysisid: string);
+    results(): ResultsEndpoint;
+    delete(): Promise<void>;
+    /**
+     * @param body Entity -
+     */
+    patch(body: Entity): Promise<Analysis>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/bulk"
+ * This is a generated file do not change manually!
+ */
+declare class BulkEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    results(): ResultsEndpoint;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/classifications"
+ * This is a generated file do not change manually!
+ */
+declare class ClassificationsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    get(): Promise<Classification[]>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/results/{resultid}/comments"
+ * This is a generated file do not change manually!
+ */
+declare class CommentsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * @param body AnalysisResultComment? -
+     */
+    post(body?: AnalysisResultComment): Promise<void>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/currentuser/roles"
+ * This is a generated file do not change manually!
+ */
+declare class RolesEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * Get the role/s of the current user.
+     */
+    get(): Promise<string[]>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/currentuser"
+ * This is a generated file do not change manually!
+ */
+declare class CurrentuserEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    roles(): RolesEndpoint;
+    /**
+     * Get information about the current user.
+     */
+    get(): Promise<CurrentUser>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/evaluations/{id}"
+ * This is a generated file do not change manually!
+ */
+declare class EvaluationEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly id;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string, id: string);
+    get(): Promise<Evaluation>;
+    /**
+     * @param body Evaluation -
+     */
+    patch(body: Evaluation): Promise<Evaluation>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/results/{resultid}/evaluations"
+ * This is a generated file do not change manually!
+ */
+declare class EvaluationsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    delete(): Promise<void>;
+    /**
+     * @param body Evaluation[] -
+     */
+    put(body: Evaluation[]): Promise<Evaluation[]>;
+    /**
+     * @param body Evaluation? -
+     */
+    post(body?: Evaluation): Promise<Evaluation>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/exceltemplates/{id}"
+ * This is a generated file do not change manually!
+ */
+declare class ExceltemplateEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly id;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string, id: string);
+    get(params?: {
+        analysisid?: string;
+    }): Promise<ExcelTemplateDetails>;
+    delete(): Promise<void>;
+    /**
+     * @param body ExcelTemplateDetails -
+     */
+    put(body: ExcelTemplateDetails): Promise<ExcelTemplateDetails>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/exceltemplates/new"
+ * This is a generated file do not change manually!
+ */
+declare class NewEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    get(params?: {
+        analysisid?: string;
+    }): Promise<ExcelTemplateDetails>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/exceltemplates"
+ * This is a generated file do not change manually!
+ */
+declare class ExceltemplatesEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    new(): NewEndpoint;
+    get(): Promise<Entity[]>;
+    /**
+     * @param body ExcelTemplateDetails? -
+     */
+    post(body?: ExcelTemplateDetails): Promise<ExcelTemplateDetails>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/references"
+ * This is a generated file do not change manually!
+ */
+declare class ReferencesEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * @param file AnalysisInput? -
+     * @param referencedocument Blob? - Optional reference documents
+     * @param tags string? -
+     * @param similaritythreshold number? -
+     * @param documentclassids string[]? -
+     * @param mode ModeEnum? -
+     */
+    post(data: {
+        file?: AnalysisInput;
+        referencedocument?: Blob;
+        tags?: string;
+        similaritythreshold?: number;
+        documentclassids?: string[];
+        mode?: ModeEnum;
+    }): Promise<ExtendedReference[]>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}/results/{resultid}"
+ * This is a generated file do not change manually!
+ */
+declare class ResultEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly resultid;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string, resultid: string);
+    comments(): CommentsEndpoint;
+    evaluations(): EvaluationsEndpoint;
+    get(params?: {
+        withreferencedocument?: boolean;
+    }): Promise<AnalysisResult>;
+    delete(): Promise<void>;
+    /**
+     * @param body AnalysisResult -
+     */
+    patch(body: AnalysisResult): Promise<AnalysisResult>;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains/{domainname}"
+ * This is a generated file do not change manually!
+ */
+declare class DomainEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly domainname;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string, domainname: string);
+    analyses(): AnalysesEndpoint;
+    analyses(analysisid: string): AnalysisEndpoint;
+    bulk(): BulkEndpoint;
+    classifications(): ClassificationsEndpoint;
+    evaluations(): EvaluationsEndpoint;
+    evaluations(id: string): EvaluationEndpoint;
+    exceltemplates(): ExceltemplatesEndpoint;
+    exceltemplates(id: string): ExceltemplateEndpoint;
+    references(): ReferencesEndpoint;
+    results(): ResultsEndpoint;
+    results(resultid: string): ResultEndpoint;
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements/domains"
+ * This is a generated file do not change manually!
+ */
+declare class DomainsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+}
+
+/**
+ * @author semantha
+ *
+ * Class to access resource "/api/requirements"
+ * This is a generated file do not change manually!
+ */
+declare class RequirementsEndpoint {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    private readonly ENDPOINT;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    currentuser(): CurrentuserEndpoint;
+    domains(): DomainsEndpoint;
+    domains(domainname: string): DomainEndpoint;
+}
+
+/**
+ * Entry point to the Requirements API.
+ *
+ * @author semantha
+ * Calls the /requirements,  endpoints.
+ *
+ * Note:
+ * The constructor is not meant to be invoked directly
+ * use `loginXXX()` with your credentials instead.
+ *
+ * this is a generated class do not change manually!
+ */
+declare class RequirementsAPI {
+    private readonly restClient;
+    private readonly parentEndpoint;
+    constructor(restClient: RestClient, parentEndpoint: string);
+    /**
+     * Access to the Requirements API
+     *
+     * @param serverUrl: string - URL to the Requirements server.
+     * @param apiKey: string - A valid bearer token for accessing the given url.
+     *
+     * @return RequirementsAPI: Entry point to the Requirements API.
+     */
+    static loginWithApiKey(serverUrl: string, apiKey: string): RequirementsAPI;
+    /**
+     * Access to the Requirements API
+     *
+     * @param serverUrl: string - URL to the Requirements server.
+     * @param clientId: string - OAuth2 client id.
+     * @param clientSecret: string - OAuth2 client secret.
+     * @param tokenUrl: string OAuth2 url to get a valid access token
+     *
+     * @return RequirementsAPI: Entry point to the Requirements API.
+     */
+    static loginWithCredentials(serverUrl: string, clientId: string, clientSecret: string, tokenUrl: string): RequirementsAPI;
+    /**
+     * Access to the Requirements API
+     *
+     * @param credentialsFilePath: string - Path to a properties file providing client credentials.
+     *
+     * @return RequirementsAPI: Entry point to the Requirements API.
+     */
+    static loginWithCredentialsFile(credentialsFilePath: string): RequirementsAPI;
+    private static parseServerUrl;
+    private static getValueOfInPropertiesFile;
+    endpoint(): string;
+    requirements(): RequirementsEndpoint;
+}
+
+export { AnalysesEndpoint, AnalysisEndpoint, BulkEndpoint, ClassificationsEndpoint, CommentsEndpoint, CurrentuserEndpoint, DomainEndpoint, DomainsEndpoint, EvaluationEndpoint, EvaluationsEndpoint, ExceltemplateEndpoint, ExceltemplatesEndpoint, ExportEndpoint, NewEndpoint, ReferencesEndpoint, ReportEndpoint, RequirementsAPI, RequirementsEndpoint, ResultEndpoint, ResultsEndpoint, RolesEndpoint };