150 lines
4.9 KiB
TypeScript
150 lines
4.9 KiB
TypeScript
import { ClientParams } from './Client';
|
|
import { RequestConfig, RequestOptions, RequestConstructorConfig } from '../request/Request';
|
|
import Request from '../request';
|
|
export declare type ClientConnectParams = Pick<ClientParams, 'config' | 'options'>;
|
|
declare class Client {
|
|
private version;
|
|
private config;
|
|
private options;
|
|
private apiKey?;
|
|
private apiSecret?;
|
|
private apiToken?;
|
|
constructor(params: ClientParams);
|
|
getPackageVersion(): string;
|
|
getAPIKey(): string | undefined;
|
|
getAPISecret(): string | undefined;
|
|
getAPIToken(): string | undefined;
|
|
getConfig(): {
|
|
host: string;
|
|
version: string;
|
|
output: import("axios").ResponseType;
|
|
};
|
|
getOptions(): RequestOptions;
|
|
get(resource: string, config?: RequestConstructorConfig): Request;
|
|
post(resource: string, config?: RequestConstructorConfig): Request;
|
|
put(resource: string, config?: RequestConstructorConfig): Request;
|
|
delete(resource: string, config?: RequestConstructorConfig): Request;
|
|
private init;
|
|
private cloneParams;
|
|
private setConfig;
|
|
private setOptions;
|
|
private tokenConnectStrategy;
|
|
private basicConnectStrategy;
|
|
static apiConnect(apiKey: string, apiSecret: string, params?: ClientConnectParams): Client;
|
|
static smsConnect(apiToken: string, params?: ClientConnectParams): Client;
|
|
static config: Readonly<RequestConfig>;
|
|
static packageJSON: Readonly<{
|
|
readonly name: string;
|
|
readonly version: string;
|
|
readonly main: string;
|
|
readonly browser: string;
|
|
readonly types: string;
|
|
readonly description: string;
|
|
readonly author: string;
|
|
readonly license: string;
|
|
readonly private: boolean;
|
|
readonly keywords: string[];
|
|
readonly engines: {
|
|
node: string;
|
|
npm: string;
|
|
};
|
|
readonly files: string[];
|
|
readonly directories: {
|
|
lib: string;
|
|
docs: string;
|
|
};
|
|
readonly typescript: {
|
|
definition: string;
|
|
};
|
|
readonly scripts: {
|
|
test: string;
|
|
"test:int": string;
|
|
"test:unit": string;
|
|
"test:watch": string;
|
|
cover: string;
|
|
"cover:int": string;
|
|
"cover:unit": string;
|
|
"cover:expandable": string;
|
|
build: string;
|
|
"build:dev": string;
|
|
"build:release": string;
|
|
"build:prepublish": string;
|
|
"build:watch": string;
|
|
lint: string;
|
|
"lint:fix": string;
|
|
"lint:errors": string;
|
|
"ts:run": string;
|
|
"ts:watch": string;
|
|
"ts:mocha": string;
|
|
"ts:patch": string;
|
|
init: string;
|
|
"pkg:link": string;
|
|
"pkg:prepare": string;
|
|
"pkg:precommit": string;
|
|
release: string;
|
|
"release:dry": string;
|
|
"release:quiet": string;
|
|
"release:minor": string;
|
|
"release:patch": string;
|
|
"release:major": string;
|
|
docs: string;
|
|
};
|
|
readonly dependencies: {
|
|
axios: string;
|
|
"json-bigint": string;
|
|
"url-join": string;
|
|
};
|
|
readonly devDependencies: {
|
|
"@babel/core": string;
|
|
"@babel/preset-env": string;
|
|
"@commitlint/cli": string;
|
|
"@commitlint/config-conventional": string;
|
|
"@types/chai": string;
|
|
"@types/json-bigint": string;
|
|
"@types/mocha": string;
|
|
"@types/node": string;
|
|
"@types/qs": string;
|
|
"@types/superagent": string;
|
|
"@types/url-join": string;
|
|
"@typescript-eslint/eslint-plugin": string;
|
|
"@typescript-eslint/parser": string;
|
|
"babel-loader": string;
|
|
chai: string;
|
|
eslint: string;
|
|
"eslint-config-airbnb-base": string;
|
|
"eslint-import-resolver-typescript": string;
|
|
"eslint-plugin-import": string;
|
|
"eslint-plugin-tsdoc": string;
|
|
husky: string;
|
|
mocha: string;
|
|
nock: string;
|
|
nyc: string;
|
|
qs: string;
|
|
"standard-version": string;
|
|
"terser-webpack-plugin": string;
|
|
"ts-loader": string;
|
|
"ts-node": string;
|
|
"ts-node-dev": string;
|
|
"ts-patch": string;
|
|
"tsconfig-paths": string;
|
|
"tsconfig-paths-webpack-plugin": string;
|
|
typedoc: string;
|
|
typescript: string;
|
|
"typescript-transform-paths": string;
|
|
webpack: string;
|
|
"webpack-cli": string;
|
|
"webpack-merge": string;
|
|
};
|
|
readonly homepage: string;
|
|
readonly repository: {
|
|
type: string;
|
|
url: string;
|
|
};
|
|
readonly bugs: {
|
|
url: string;
|
|
};
|
|
readonly contributors: string[];
|
|
}>;
|
|
}
|
|
export default Client;
|