| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546 |
- import { WebResource } from "../webResource";
- import { ServiceClientCredentials } from "./serviceClientCredentials";
- /**
- * @interface ApiKeyCredentialOptions
- * Describes the options to be provided while creating an instance of ApiKeyCredentials
- */
- export interface ApiKeyCredentialOptions {
- /**
- * A key value pair of the header parameters that need to be applied to the request.
- */
- inHeader?: {
- [x: string]: any;
- };
- /**
- * A key value pair of the query parameters that need to be applied to the request.
- */
- inQuery?: {
- [x: string]: any;
- };
- }
- /**
- * Authenticates to a service using an API key.
- */
- export declare class ApiKeyCredentials implements ServiceClientCredentials {
- /**
- * A key value pair of the header parameters that need to be applied to the request.
- */
- private readonly inHeader?;
- /**
- * A key value pair of the query parameters that need to be applied to the request.
- */
- private readonly inQuery?;
- /**
- * @constructor
- * @param {object} options Specifies the options to be provided for auth. Either header or query needs to be provided.
- */
- constructor(options: ApiKeyCredentialOptions);
- /**
- * Signs a request with the values provided in the inHeader and inQuery parameter.
- *
- * @param {WebResource} webResource The WebResource to be signed.
- * @returns {Promise<WebResource>} The signed request object.
- */
- signRequest(webResource: WebResource): Promise<WebResource>;
- }
- //# sourceMappingURL=apiKeyCredentials.d.ts.map
|