@studyportals/sp-hs-misc/bin/src/requests/interfaces/i-signed-super-agent-request-factory.interface.d.ts

Miscellaneous code used in HouseStark's projects

import { SuperAgentRequest } from "superagent";
import { ISuperAgentRequestFactory } from "./i-super-agent-request-factory.interface";
/**
 * Provides the necessary functionality to create new SuperAgentRequest instances,
 * while also exposing the possibility of signing the requests so that the receiving
 * party recognizes the user's identity.
 *
 * @deprecated Use the SessionTokenRequestSigner instead.
 * @deprecated Use @studyportals/mb-platform-http-requests
 */
interface ISignedSuperAgentRequestFactory extends ISuperAgentRequestFactory {
    /**
     * Creates a GET request to the specified path.
     *
     * Configures the request in such a way that the receiving party
     * will be able to recognise the user's identity.
     */
    getSigned(path: string): SuperAgentRequest;
    /**
     * Creates a POST request to the specified path.
     *
     * Configures the request in such a way that the receiving party
     * will be able to recognise the user's identity.
     */
    postSigned(path: string): SuperAgentRequest;
    /**
     * Creates a PUT request to the specified path.
     *
     * Configures the request in such a way that the receiving party
     * will be able to recognise the user's identity.
     */
    putSigned(path: string): SuperAgentRequest;
    /**
     * Creates a DELETE request to the specified path.
     *
     * Configures the request in such a way that the receiving party
     * will be able to recognise the user's identity.
     */
    deleteSigned(path: string): SuperAgentRequest;
}
export { ISignedSuperAgentRequestFactory };