ebay-api/dist/api/digitalSignature.d.ts

eBay API for Node and Browser

import { Cipher, Headers } from '../types/index.js';
/**
 * Generates the 'Content-Digest' header value for the input payload.
 *
 * @param {any} payload The request payload.
 * @param {string} cipher The algorithm used to calculate the digest.
 * @returns {string} contentDigest The 'Content-Digest' header value.
 */
export declare const generateContentDigestValue: (payload: unknown, cipher?: Cipher) => string;
export type SignatureComponents = {
    method: string;
    authority: string;
    path: string;
};
/**
 * Generates the base string.
 *
 * @param {any} headers The HTTP request headers.
 * @param {SignatureComponents} signatureComponents The config.
 * @param {any} payload The payload.
 * @param {number} timestamp The timestamp.
 * @returns {string} payload The base string.
 */
export declare function generateBaseString(headers: Headers, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;
/**
 * Generates the Signature-Input header value for the input payload.
 *
 * @param {any} payload The input config.
 * @param {number} timestamp The timestamp.
 * @returns {string} the 'Signature-Input' header value.
 */
export declare const generateSignatureInput: (payload: any, timestamp?: number) => string;
/**
 * Generates the 'Signature' header.
 *
 * @param {any} headers The HTTP headers.
 * @param {string} privateKey The HTTP headers.
 * @param {SignatureComponents} signatureComponents The signature components
 * @param {any} payload The payload
 * @param {number} timestamp The payload
 * @returns {string} the signature header value.
 */
export declare function generateSignature(headers: any, privateKey: string, signatureComponents: SignatureComponents, payload: any, timestamp?: number): string;