cypress-xray-plugin/src/client/client.d.ts

A Cypress plugin for uploading test results to Xray (test management for Jira)

import type { HttpCredentials } from "./authentication/credentials";
import type { AxiosRestClient } from "./https/requests";
/**
 * A basic client interface which stores credentials data used for communicating with a server.
 */
export declare abstract class Client {
    /**
     * The server URL.
     */
    protected readonly apiBaseUrl: string;
    /**
     * The credentials to use for authentication.
     */
    protected readonly credentials: HttpCredentials;
    /**
     * The HTTP client to use for dispatching requests.
     */
    protected readonly httpClient: AxiosRestClient;
    /**
     * Construct a new client using the provided credentials.
     *
     * @param apiBaseUrl - the base URL for all HTTP requests
     * @param credentials - the credentials to use during authentication
     * @param httpClient - the HTTP client to use for dispatching requests
     */
    constructor(apiBaseUrl: string, credentials: HttpCredentials, httpClient: AxiosRestClient);
    /**
     * Return the client's credentials;
     *
     * @returns the credentials
     */
    getCredentials(): HttpCredentials;
}